Class AggregateError

Namespace

FunctionalDdd

Assembly

FunctionalDdd.RailwayOrientedProgramming.dll

Represents an aggregate of multiple errors that occurred together. Use this when multiple independent errors need to be returned as a single failure result.

public sealed class AggregateError : Error, IEquatable<Error>

Inheritance

object

Error

AggregateError

Implements

IEquatable<Error>

Inherited Members

Error.Code

Error.Detail

Error.Instance

Error.Equals(Error)

Error.Equals(object)

Error.GetHashCode()

Error.ToString()

Error.Validation(string, string, string, string)

Error.Validation(ImmutableArray<ValidationError.FieldError>, string, string)

Error.Validation(ImmutableArray<ValidationError.FieldError>, string, string, string)

Error.BadRequest(string, string)

Error.Conflict(string, string)

Error.NotFound(string, string)

Error.Unauthorized(string, string)

Error.Forbidden(string, string)

Error.Unexpected(string, string)

Error.Domain(string, string)

Error.RateLimit(string, string)

Error.ServiceUnavailable(string, string)

Error.BadRequest(string, string, string)

Error.Conflict(string, string, string)

Error.NotFound(string, string, string)

Error.Unauthorized(string, string, string)

Error.Forbidden(string, string, string)

Error.Unexpected(string, string, string)

Error.Domain(string, string, string)

Error.RateLimit(string, string, string)

Error.ServiceUnavailable(string, string, string)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

MaybeExtensions.AsMaybe<T>(T)

MaybeExtensions.ToResult<TValue>(TValue)

NullableExtensions.ToResult<T>(T?, Error)

CombineErrorExtensions.Combine(Error?, Error)

Examples

var errors = new List<Error>
{
    Error.Validation("Invalid email", "email"),
    Error.NotFound("User not found", userId),
    Error.Domain("Insufficient balance")
};
var aggregateError = new AggregateError(errors);

Remarks

This is useful for scenarios where multiple operations fail independently, such as batch processing or parallel validation of multiple entities.

The aggregated errors can be of different types and are accessible via the Errors property. This type is immutable - the errors collection cannot be modified after creation.

Constructors

AggregateError(IReadOnlyList<Error>)

Initializes a new instance of the AggregateError class with the specified errors. Uses the default error code "aggregate.error".

public AggregateError(IReadOnlyList<Error> errors)

Parameters

errors IReadOnlyList<Error>

The collection of errors to aggregate. Must contain at least one error.

Exceptions

ArgumentException

Thrown when errors is empty.

AggregateError(IReadOnlyList<Error>, string)

Initializes a new instance of the AggregateError class with the specified errors and custom error code.

public AggregateError(IReadOnlyList<Error> errors, string code)

Parameters

errors IReadOnlyList<Error>

The collection of errors to aggregate. Must contain at least one error.

code string

The custom error code for this aggregate error.

Exceptions

ArgumentException

Thrown when errors is empty.

Properties

Errors

Gets the collection of aggregated errors.

public IReadOnlyList<Error> Errors { get; }

Property Value

IReadOnlyList<Error>

A read-only list of Error instances that were aggregated together.