Class MatchExtensionsAsync

Namespace

Trellis

Assembly

Trellis.Results.dll

Asynchronous pattern matching helpers for Result.

public static class MatchExtensionsAsync

Inheritance

object

MatchExtensionsAsync

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

MatchAsync<TIn, TOut>(Task<Result<TIn>>, Func<TIn, CancellationToken, Task<TOut>>, Func<Error, CancellationToken, Task<TOut>>, CancellationToken)

Executes either the success or failure async function based on the result state.

public static Task<TOut> MatchAsync<TIn, TOut>(this Task<Result<TIn>> resultTask, Func<TIn, CancellationToken, Task<TOut>> onSuccess, Func<Error, CancellationToken, Task<TOut>> onFailure, CancellationToken cancellationToken = default)

Parameters

resultTask Task<Result<TIn>>

The task representing the result to match on.

onSuccess Func<TIn, CancellationToken, Task<TOut>>

Async function to execute on success.

onFailure Func<Error, CancellationToken, Task<TOut>>

Async function to execute on failure.

cancellationToken CancellationToken

Cancellation token to observe.

Returns

Task<TOut>

A task that represents the asynchronous operation. The task result contains the output from either the success or failure function.

Type Parameters

TIn

Type of the result value.

TOut

Type of the output.

MatchAsync<TIn, TOut>(Task<Result<TIn>>, Func<TIn, Task<TOut>>, Func<Error, Task<TOut>>)

Executes either the success or failure async function based on the result state.

public static Task<TOut> MatchAsync<TIn, TOut>(this Task<Result<TIn>> resultTask, Func<TIn, Task<TOut>> onSuccess, Func<Error, Task<TOut>> onFailure)

Parameters

resultTask Task<Result<TIn>>

The task representing the result to match on.

onSuccess Func<TIn, Task<TOut>>

Async function to execute on success.

onFailure Func<Error, Task<TOut>>

Async function to execute on failure.

Returns

Task<TOut>

A task that represents the asynchronous operation. The task result contains the output from either the success or failure function.

Type Parameters

TIn

Type of the result value.

TOut

Type of the output.

MatchAsync<TIn, TOut>(Task<Result<TIn>>, Func<TIn, TOut>, Func<Error, TOut>)

Executes either the success or failure function based on the result state.

public static Task<TOut> MatchAsync<TIn, TOut>(this Task<Result<TIn>> resultTask, Func<TIn, TOut> onSuccess, Func<Error, TOut> onFailure)

Parameters

resultTask Task<Result<TIn>>

The task representing the result to match on.

onSuccess Func<TIn, TOut>

Function to execute on success.

onFailure Func<Error, TOut>

Function to execute on failure.

Returns

Task<TOut>

The output from either the success or failure function.

Type Parameters

TIn

Type of the result value.

TOut

Type of the output.

MatchAsync<TIn, TOut>(ValueTask<Result<TIn>>, Func<TIn, ValueTask<TOut>>, Func<Error, ValueTask<TOut>>)

Executes either the success or failure async function based on the ValueTask result state. Both sides are async (ValueTask).

public static ValueTask<TOut> MatchAsync<TIn, TOut>(this ValueTask<Result<TIn>> resultTask, Func<TIn, ValueTask<TOut>> onSuccess, Func<Error, ValueTask<TOut>> onFailure)

Parameters

resultTask ValueTask<Result<TIn>>

onSuccess Func<TIn, ValueTask<TOut>>

onFailure Func<Error, ValueTask<TOut>>

Returns

ValueTask<TOut>

Type Parameters

TIn

TOut

MatchAsync<TIn, TOut>(ValueTask<Result<TIn>>, Func<TIn, TOut>, Func<Error, TOut>)

Executes either the success or failure function based on the ValueTask result state. Left is async (ValueTask), handlers are sync.

public static ValueTask<TOut> MatchAsync<TIn, TOut>(this ValueTask<Result<TIn>> resultTask, Func<TIn, TOut> onSuccess, Func<Error, TOut> onFailure)

Parameters

resultTask ValueTask<Result<TIn>>

onSuccess Func<TIn, TOut>

onFailure Func<Error, TOut>

Returns

ValueTask<TOut>

Type Parameters

TIn

TOut

MatchAsync<TIn, TOut>(Result<TIn>, Func<TIn, CancellationToken, Task<TOut>>, Func<Error, CancellationToken, Task<TOut>>, CancellationToken)

Executes either the success or failure async function based on the result state.

public static Task<TOut> MatchAsync<TIn, TOut>(this Result<TIn> result, Func<TIn, CancellationToken, Task<TOut>> onSuccess, Func<Error, CancellationToken, Task<TOut>> onFailure, CancellationToken cancellationToken = default)

Parameters

result Result<TIn>

The result to match on.

onSuccess Func<TIn, CancellationToken, Task<TOut>>

Async function to execute on success.

onFailure Func<Error, CancellationToken, Task<TOut>>

Async function to execute on failure.

cancellationToken CancellationToken

Cancellation token to observe.

Returns

Task<TOut>

A task that represents the asynchronous operation. The task result contains the output from either the success or failure function.

Type Parameters

TIn

Type of the result value.

TOut

Type of the output.

MatchAsync<TIn, TOut>(Result<TIn>, Func<TIn, Task<TOut>>, Func<Error, Task<TOut>>)

Executes either the success or failure async function based on the result state.

public static Task<TOut> MatchAsync<TIn, TOut>(this Result<TIn> result, Func<TIn, Task<TOut>> onSuccess, Func<Error, Task<TOut>> onFailure)

Parameters

result Result<TIn>

The result to match on.

onSuccess Func<TIn, Task<TOut>>

Async function to execute on success.

onFailure Func<Error, Task<TOut>>

Async function to execute on failure.

Returns

Task<TOut>

A task that represents the asynchronous operation. The task result contains the output from either the success or failure function.

Type Parameters

TIn

Type of the result value.

TOut

Type of the output.

MatchAsync<TIn, TOut>(Result<TIn>, Func<TIn, ValueTask<TOut>>, Func<Error, ValueTask<TOut>>)

Executes either the success or failure async function based on the result state. Right is async (ValueTask).

public static ValueTask<TOut> MatchAsync<TIn, TOut>(this Result<TIn> result, Func<TIn, ValueTask<TOut>> onSuccess, Func<Error, ValueTask<TOut>> onFailure)

Parameters

result Result<TIn>

onSuccess Func<TIn, ValueTask<TOut>>

onFailure Func<Error, ValueTask<TOut>>

Returns

ValueTask<TOut>

Type Parameters

TIn

TOut

SwitchAsync<TIn>(Task<Result<TIn>>, Func<TIn, CancellationToken, Task>, Func<Error, CancellationToken, Task>, CancellationToken)

Executes either the success or failure async action based on the result state.

public static Task SwitchAsync<TIn>(this Task<Result<TIn>> resultTask, Func<TIn, CancellationToken, Task> onSuccess, Func<Error, CancellationToken, Task> onFailure, CancellationToken cancellationToken = default)

Parameters

resultTask Task<Result<TIn>>

The task representing the result to switch on.

onSuccess Func<TIn, CancellationToken, Task>

Async action to execute on success.

onFailure Func<Error, CancellationToken, Task>

Async action to execute on failure.

cancellationToken CancellationToken

Cancellation token to observe.

Returns

Task

A task that represents the asynchronous operation.

Type Parameters

TIn

Type of the result value.

SwitchAsync<TIn>(Task<Result<TIn>>, Func<TIn, Task>, Func<Error, Task>)

Executes either the success or failure async action based on the result state.

public static Task SwitchAsync<TIn>(this Task<Result<TIn>> resultTask, Func<TIn, Task> onSuccess, Func<Error, Task> onFailure)

Parameters

resultTask Task<Result<TIn>>

The task representing the result to switch on.

onSuccess Func<TIn, Task>

Async action to execute on success.

onFailure Func<Error, Task>

Async action to execute on failure.

Returns

Task

A task that represents the asynchronous operation.

Type Parameters

TIn

Type of the result value.

SwitchAsync<TIn>(ValueTask<Result<TIn>>, Func<TIn, ValueTask>, Func<Error, ValueTask>)

Executes either the success or failure async action based on the ValueTask result state. Both are async (ValueTask).

public static ValueTask SwitchAsync<TIn>(this ValueTask<Result<TIn>> resultTask, Func<TIn, ValueTask> onSuccess, Func<Error, ValueTask> onFailure)

Parameters

resultTask ValueTask<Result<TIn>>

onSuccess Func<TIn, ValueTask>

onFailure Func<Error, ValueTask>

Returns

ValueTask

Type Parameters

TIn