Class MatchErrorExtensionsAsync

Namespace

FunctionalDdd

Assembly

FunctionalDdd.RailwayOrientedProgramming.dll

Asynchronous pattern matching helpers for discriminating specific error types in Result.

public static class MatchErrorExtensionsAsync

Inheritance

object

MatchErrorExtensionsAsync

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

MatchErrorAsync<TIn, TOut>(Result<TIn>, Func<TIn, CancellationToken, Task<TOut>>, Func<ValidationError, CancellationToken, Task<TOut>>?, Func<NotFoundError, CancellationToken, Task<TOut>>?, Func<ConflictError, CancellationToken, Task<TOut>>?, Func<BadRequestError, CancellationToken, Task<TOut>>?, Func<UnauthorizedError, CancellationToken, Task<TOut>>?, Func<ForbiddenError, CancellationToken, Task<TOut>>?, Func<DomainError, CancellationToken, Task<TOut>>?, Func<RateLimitError, CancellationToken, Task<TOut>>?, Func<ServiceUnavailableError, CancellationToken, Task<TOut>>?, Func<UnexpectedError, CancellationToken, Task<TOut>>?, Func<Error, CancellationToken, Task<TOut>>?, CancellationToken)

Asynchronously pattern matches on the result with async handlers for different error types.

public static Task<TOut> MatchErrorAsync<TIn, TOut>(this Result<TIn> result, Func<TIn, CancellationToken, Task<TOut>> onSuccess, Func<ValidationError, CancellationToken, Task<TOut>>? onValidation = null, Func<NotFoundError, CancellationToken, Task<TOut>>? onNotFound = null, Func<ConflictError, CancellationToken, Task<TOut>>? onConflict = null, Func<BadRequestError, CancellationToken, Task<TOut>>? onBadRequest = null, Func<UnauthorizedError, CancellationToken, Task<TOut>>? onUnauthorized = null, Func<ForbiddenError, CancellationToken, Task<TOut>>? onForbidden = null, Func<DomainError, CancellationToken, Task<TOut>>? onDomain = null, Func<RateLimitError, CancellationToken, Task<TOut>>? onRateLimit = null, Func<ServiceUnavailableError, CancellationToken, Task<TOut>>? onServiceUnavailable = null, Func<UnexpectedError, CancellationToken, Task<TOut>>? onUnexpected = null, Func<Error, CancellationToken, Task<TOut>>? onError = null, CancellationToken cancellationToken = default)

Parameters

result Result<TIn>

The result to match on.

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

Async function to execute on success.

onValidation Func<ValidationError, CancellationToken, Task<TOut>>

Async function to execute when the error is a ValidationError.

onNotFound Func<NotFoundError, CancellationToken, Task<TOut>>

Async function to execute when the error is a NotFoundError.

onConflict Func<ConflictError, CancellationToken, Task<TOut>>

Async function to execute when the error is a ConflictError.

onBadRequest Func<BadRequestError, CancellationToken, Task<TOut>>

Async function to execute when the error is a BadRequestError.

onUnauthorized Func<UnauthorizedError, CancellationToken, Task<TOut>>

Async function to execute when the error is an UnauthorizedError.

onForbidden Func<ForbiddenError, CancellationToken, Task<TOut>>

Async function to execute when the error is a ForbiddenError.

onDomain Func<DomainError, CancellationToken, Task<TOut>>

Async function to execute when the error is a DomainError.

onRateLimit Func<RateLimitError, CancellationToken, Task<TOut>>

Async function to execute when the error is a RateLimitError.

onServiceUnavailable Func<ServiceUnavailableError, CancellationToken, Task<TOut>>

Async function to execute when the error is a ServiceUnavailableError.

onUnexpected Func<UnexpectedError, CancellationToken, Task<TOut>>

Async function to execute when the error is an UnexpectedError.

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

Default async function to execute for any other error type.

cancellationToken CancellationToken

The cancellation token to observe.

Returns

Task<TOut>

A task that represents the asynchronous operation. The task result contains the output from the appropriate handler function.

Type Parameters

TIn

Type of the result value.

TOut

Type of the output.

MatchErrorAsync<TIn, TOut>(Task<Result<TIn>>, Func<TIn, CancellationToken, Task<TOut>>, Func<ValidationError, CancellationToken, Task<TOut>>?, Func<NotFoundError, CancellationToken, Task<TOut>>?, Func<ConflictError, CancellationToken, Task<TOut>>?, Func<BadRequestError, CancellationToken, Task<TOut>>?, Func<UnauthorizedError, CancellationToken, Task<TOut>>?, Func<ForbiddenError, CancellationToken, Task<TOut>>?, Func<DomainError, CancellationToken, Task<TOut>>?, Func<RateLimitError, CancellationToken, Task<TOut>>?, Func<ServiceUnavailableError, CancellationToken, Task<TOut>>?, Func<UnexpectedError, CancellationToken, Task<TOut>>?, Func<Error, CancellationToken, Task<TOut>>?, CancellationToken)

Asynchronously pattern matches on the result with async handlers for different error types.

public static Task<TOut> MatchErrorAsync<TIn, TOut>(this Task<Result<TIn>> resultTask, Func<TIn, CancellationToken, Task<TOut>> onSuccess, Func<ValidationError, CancellationToken, Task<TOut>>? onValidation = null, Func<NotFoundError, CancellationToken, Task<TOut>>? onNotFound = null, Func<ConflictError, CancellationToken, Task<TOut>>? onConflict = null, Func<BadRequestError, CancellationToken, Task<TOut>>? onBadRequest = null, Func<UnauthorizedError, CancellationToken, Task<TOut>>? onUnauthorized = null, Func<ForbiddenError, CancellationToken, Task<TOut>>? onForbidden = null, Func<DomainError, CancellationToken, Task<TOut>>? onDomain = null, Func<RateLimitError, CancellationToken, Task<TOut>>? onRateLimit = null, Func<ServiceUnavailableError, CancellationToken, Task<TOut>>? onServiceUnavailable = null, Func<UnexpectedError, CancellationToken, Task<TOut>>? onUnexpected = null, Func<Error, CancellationToken, Task<TOut>>? onError = null, 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.

onValidation Func<ValidationError, CancellationToken, Task<TOut>>

Async function to execute when the error is a ValidationError.

onNotFound Func<NotFoundError, CancellationToken, Task<TOut>>

Async function to execute when the error is a NotFoundError.

onConflict Func<ConflictError, CancellationToken, Task<TOut>>

Async function to execute when the error is a ConflictError.

onBadRequest Func<BadRequestError, CancellationToken, Task<TOut>>

Async function to execute when the error is a BadRequestError.

onUnauthorized Func<UnauthorizedError, CancellationToken, Task<TOut>>

Async function to execute when the error is an UnauthorizedError.

onForbidden Func<ForbiddenError, CancellationToken, Task<TOut>>

Async function to execute when the error is a ForbiddenError.

onDomain Func<DomainError, CancellationToken, Task<TOut>>

Async function to execute when the error is a DomainError.

onRateLimit Func<RateLimitError, CancellationToken, Task<TOut>>

Async function to execute when the error is a RateLimitError.

onServiceUnavailable Func<ServiceUnavailableError, CancellationToken, Task<TOut>>

Async function to execute when the error is a ServiceUnavailableError.

onUnexpected Func<UnexpectedError, CancellationToken, Task<TOut>>

Async function to execute when the error is an UnexpectedError.

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

Default async function to execute for any other error type.

cancellationToken CancellationToken

The cancellation token to observe.

Returns

Task<TOut>

A task that represents the asynchronous operation. The task result contains the output from the appropriate handler function.

Type Parameters

TIn

Type of the result value.

TOut

Type of the output.

MatchErrorAsync<TIn, TOut>(Task<Result<TIn>>, Func<TIn, TOut>, Func<ValidationError, TOut>?, Func<NotFoundError, TOut>?, Func<ConflictError, TOut>?, Func<BadRequestError, TOut>?, Func<UnauthorizedError, TOut>?, Func<ForbiddenError, TOut>?, Func<DomainError, TOut>?, Func<RateLimitError, TOut>?, Func<ServiceUnavailableError, TOut>?, Func<UnexpectedError, TOut>?, Func<Error, TOut>?)

Asynchronously pattern matches on the result, with specific handlers for different error types.

public static Task<TOut> MatchErrorAsync<TIn, TOut>(this Task<Result<TIn>> resultTask, Func<TIn, TOut> onSuccess, Func<ValidationError, TOut>? onValidation = null, Func<NotFoundError, TOut>? onNotFound = null, Func<ConflictError, TOut>? onConflict = null, Func<BadRequestError, TOut>? onBadRequest = null, Func<UnauthorizedError, TOut>? onUnauthorized = null, Func<ForbiddenError, TOut>? onForbidden = null, Func<DomainError, TOut>? onDomain = null, Func<RateLimitError, TOut>? onRateLimit = null, Func<ServiceUnavailableError, TOut>? onServiceUnavailable = null, Func<UnexpectedError, TOut>? onUnexpected = null, Func<Error, TOut>? onError = null)

Parameters

resultTask Task<Result<TIn>>

The task representing the result to match on.

onSuccess Func<TIn, TOut>

Function to execute on success.

onValidation Func<ValidationError, TOut>

Function to execute when the error is a ValidationError.

onNotFound Func<NotFoundError, TOut>

Function to execute when the error is a NotFoundError.

onConflict Func<ConflictError, TOut>

Function to execute when the error is a ConflictError.

onBadRequest Func<BadRequestError, TOut>

Function to execute when the error is a BadRequestError.

onUnauthorized Func<UnauthorizedError, TOut>

Function to execute when the error is an UnauthorizedError.

onForbidden Func<ForbiddenError, TOut>

Function to execute when the error is a ForbiddenError.

onDomain Func<DomainError, TOut>

Function to execute when the error is a DomainError.

onRateLimit Func<RateLimitError, TOut>

Function to execute when the error is a RateLimitError.

onServiceUnavailable Func<ServiceUnavailableError, TOut>

Function to execute when the error is a ServiceUnavailableError.

onUnexpected Func<UnexpectedError, TOut>

Function to execute when the error is an UnexpectedError.

onError Func<Error, TOut>

Default function to execute for any other error type.

Returns

Task<TOut>

A task that represents the asynchronous operation. The task result contains the output from the appropriate handler function.

Type Parameters

TIn

Type of the result value.

TOut

Type of the output.

SwitchErrorAsync<TIn>(Task<Result<TIn>>, Func<TIn, CancellationToken, Task>, Func<ValidationError, CancellationToken, Task>?, Func<NotFoundError, CancellationToken, Task>?, Func<ConflictError, CancellationToken, Task>?, Func<BadRequestError, CancellationToken, Task>?, Func<UnauthorizedError, CancellationToken, Task>?, Func<ForbiddenError, CancellationToken, Task>?, Func<DomainError, CancellationToken, Task>?, Func<RateLimitError, CancellationToken, Task>?, Func<ServiceUnavailableError, CancellationToken, Task>?, Func<UnexpectedError, CancellationToken, Task>?, Func<Error, CancellationToken, Task>?, CancellationToken)

Asynchronously executes different actions based on the result state and error type.

public static Task SwitchErrorAsync<TIn>(this Task<Result<TIn>> resultTask, Func<TIn, CancellationToken, Task> onSuccess, Func<ValidationError, CancellationToken, Task>? onValidation = null, Func<NotFoundError, CancellationToken, Task>? onNotFound = null, Func<ConflictError, CancellationToken, Task>? onConflict = null, Func<BadRequestError, CancellationToken, Task>? onBadRequest = null, Func<UnauthorizedError, CancellationToken, Task>? onUnauthorized = null, Func<ForbiddenError, CancellationToken, Task>? onForbidden = null, Func<DomainError, CancellationToken, Task>? onDomain = null, Func<RateLimitError, CancellationToken, Task>? onRateLimit = null, Func<ServiceUnavailableError, CancellationToken, Task>? onServiceUnavailable = null, Func<UnexpectedError, CancellationToken, Task>? onUnexpected = null, Func<Error, CancellationToken, Task>? onError = null, 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.

onValidation Func<ValidationError, CancellationToken, Task>

Async action to execute when the error is a ValidationError.

onNotFound Func<NotFoundError, CancellationToken, Task>

Async action to execute when the error is a NotFoundError.

onConflict Func<ConflictError, CancellationToken, Task>

Async action to execute when the error is a ConflictError.

onBadRequest Func<BadRequestError, CancellationToken, Task>

Async action to execute when the error is a BadRequestError.

onUnauthorized Func<UnauthorizedError, CancellationToken, Task>

Async action to execute when the error is an UnauthorizedError.

onForbidden Func<ForbiddenError, CancellationToken, Task>

Async action to execute when the error is a ForbiddenError.

onDomain Func<DomainError, CancellationToken, Task>

Async action to execute when the error is a DomainError.

onRateLimit Func<RateLimitError, CancellationToken, Task>

Async action to execute when the error is a RateLimitError.

onServiceUnavailable Func<ServiceUnavailableError, CancellationToken, Task>

Async action to execute when the error is a ServiceUnavailableError.

onUnexpected Func<UnexpectedError, CancellationToken, Task>

Async action to execute when the error is an UnexpectedError.

onError Func<Error, CancellationToken, Task>

Default async action to execute for any other error type.

cancellationToken CancellationToken

The cancellation token to observe.

Returns

Task

A task that represents the asynchronous operation.

Type Parameters

TIn

Type of the result value.