Class OneOf<T1, T2, T3, T4>

Namespace: REslava.Result.AdvancedPatterns

Assembly: REslava.Result.dll

Represents a value that can be one of four possible types. A type-safe discriminated union for functional programming patterns.

public sealed class OneOf<T1, T2, T3, T4> : OneOfBase<T1, T2, T3, T4>, IOneOf<T1, T2, T3, T4>, IEquatable<OneOf<T1, T2, T3, T4>>

Type Parameters

T1: The first possible type.
T2: The second possible type.
T3: The third possible type.
T4: The fourth possible type.

Inheritance: object

OneOfBase<T1, T2, T3, T4>

OneOf<T1, T2, T3, T4>

Implements: IOneOf<T1, T2, T3, T4>

IEquatable<OneOf<T1, T2, T3, T4>>

Inherited Members: OneOfBase<T1, T2, T3, T4>.IsT1

OneOfBase<T1, T2, T3, T4>.IsT2

OneOfBase<T1, T2, T3, T4>.IsT3

OneOfBase<T1, T2, T3, T4>.IsT4

OneOfBase<T1, T2, T3, T4>.AsT1

OneOfBase<T1, T2, T3, T4>.AsT2

OneOfBase<T1, T2, T3, T4>.AsT3

OneOfBase<T1, T2, T3, T4>.AsT4

OneOfBase<T1, T2, T3, T4>.Match<TResult>(Func<T1, TResult>, Func<T2, TResult>, Func<T3, TResult>, Func<T4, TResult>)

OneOfBase<T1, T2, T3, T4>.Switch(Action<T1>, Action<T2>, Action<T3>, Action<T4>)

OneOfBase<T1, T2, T3, T4>.ToString()

OneOfBase<T1, T2, T3, T4>.Equals(object)

OneOfBase<T1, T2, T3, T4>.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods: OneOfExtensions.ToFiveWay<T1, T2, T3, T4, T5>(OneOf<T1, T2, T3, T4>, T5)

OneOfExtensions.ToThreeWay<T1, T2, T3, T4>(OneOf<T1, T2, T3, T4>)

OneOfExtensions.ToThreeWay<T1, T2, T3, T4>(OneOf<T1, T2, T3, T4>, Func<T4, T1>?, Func<T4, T2>?, Func<T4, T3>?)

ValidationExtensions.EnsureNotNull<TCollection>(TCollection?, string, string?)

Examples

OneOf<SuccessData, ValidationError, NotFoundError, ServerError> response = await CallApi();
return response.Match(
    case1: data => ProcessData(data),
    case2: validationError => HandleValidationError(validationError),
    case3: notFoundError => HandleNotFoundError(notFoundError),
    case4: serverError => HandleServerError(serverError)
);

Methods

BindT2<TNewT2>(Func<T2, OneOf<T1, TNewT2, T3, T4>>)

Binds the T2 value if present, otherwise propagates other types.

public OneOf<T1, TNewT2, T3, T4> BindT2<TNewT2>(Func<T2, OneOf<T1, TNewT2, T3, T4>> binder)

Parameters

binder Func<T2, OneOf<T1, TNewT2, T3, T4>>

Returns

OneOf<T1, TNewT2, T3, T4>

Type Parameters

TNewT2

Exceptions

ArgumentNullException: Thrown when binder is null.

BindT3<TNewT3>(Func<T3, OneOf<T1, T2, TNewT3, T4>>)

Binds the T3 value if present, otherwise propagates other types.

public OneOf<T1, T2, TNewT3, T4> BindT3<TNewT3>(Func<T3, OneOf<T1, T2, TNewT3, T4>> binder)

Parameters

binder Func<T3, OneOf<T1, T2, TNewT3, T4>>

Returns

OneOf<T1, T2, TNewT3, T4>

Type Parameters

TNewT3

Exceptions

ArgumentNullException: Thrown when binder is null.

Equals(OneOf<T1, T2, T3, T4>?)

Determines equality between two OneOf instances.

public bool Equals(OneOf<T1, T2, T3, T4>? other)

Parameters

other OneOf<T1, T2, T3, T4>

Returns

bool

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object: The object to compare with the current object.

Returns

bool: true if the specified object is equal to the current object; otherwise, false.

FromT1(T1)

Creates a OneOf containing a T1 value.

public static OneOf<T1, T2, T3, T4> FromT1(T1 value)

Parameters

value T1

Returns

OneOf<T1, T2, T3, T4>

FromT2(T2)

Creates a OneOf containing a T2 value.

public static OneOf<T1, T2, T3, T4> FromT2(T2 value)

Parameters

value T2

Returns

OneOf<T1, T2, T3, T4>

FromT3(T3)

Creates a OneOf containing a T3 value.

public static OneOf<T1, T2, T3, T4> FromT3(T3 value)

Parameters

value T3

Returns

OneOf<T1, T2, T3, T4>

FromT4(T4)

Creates a OneOf containing a T4 value.

public static OneOf<T1, T2, T3, T4> FromT4(T4 value)

Parameters

value T4

Returns

OneOf<T1, T2, T3, T4>

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int: A hash code for the current object.

MapT2<TNewT2>(Func<T2, TNewT2>)

Maps the T2 value if present, otherwise propagates other types.

public OneOf<T1, TNewT2, T3, T4> MapT2<TNewT2>(Func<T2, TNewT2> mapper)

Parameters

mapper Func<T2, TNewT2>

Returns

OneOf<T1, TNewT2, T3, T4>

Type Parameters

TNewT2

Exceptions

ArgumentNullException: Thrown when mapper is null.

MapT3<TNewT3>(Func<T3, TNewT3>)

Maps the T3 value if present, otherwise propagates other types.

public OneOf<T1, T2, TNewT3, T4> MapT3<TNewT3>(Func<T3, TNewT3> mapper)

Parameters

mapper Func<T3, TNewT3>

Returns

OneOf<T1, T2, TNewT3, T4>

Type Parameters

TNewT3

Exceptions

ArgumentNullException: Thrown when mapper is null.

Operators

operator ==(OneOf<T1, T2, T3, T4>?, OneOf<T1, T2, T3, T4>?)

Equality operator for OneOf instances.

public static bool operator ==(OneOf<T1, T2, T3, T4>? left, OneOf<T1, T2, T3, T4>? right)

Parameters

left OneOf<T1, T2, T3, T4>
right OneOf<T1, T2, T3, T4>

Returns

bool

implicit operator OneOf<T1, T2, T3, T4>(T1)

Implicit conversion from T1.

public static implicit operator OneOf<T1, T2, T3, T4>(T1 value)

Parameters

value T1

Returns

OneOf<T1, T2, T3, T4>

implicit operator OneOf<T1, T2, T3, T4>(T2)

Implicit conversion from T2.

public static implicit operator OneOf<T1, T2, T3, T4>(T2 value)

Parameters

value T2

Returns

OneOf<T1, T2, T3, T4>

implicit operator OneOf<T1, T2, T3, T4>(T3)

Implicit conversion from T3.

public static implicit operator OneOf<T1, T2, T3, T4>(T3 value)

Parameters

value T3

Returns

OneOf<T1, T2, T3, T4>

implicit operator OneOf<T1, T2, T3, T4>(T4)

Implicit conversion from T4.

public static implicit operator OneOf<T1, T2, T3, T4>(T4 value)

Parameters

value T4

Returns

OneOf<T1, T2, T3, T4>

operator !=(OneOf<T1, T2, T3, T4>?, OneOf<T1, T2, T3, T4>?)

Inequality operator for OneOf instances.

public static bool operator !=(OneOf<T1, T2, T3, T4>? left, OneOf<T1, T2, T3, T4>? right)

Parameters

left OneOf<T1, T2, T3, T4>
right OneOf<T1, T2, T3, T4>

Returns

bool