Struct OneOf<T1, T2, T3, T4, T5>

Namespace

Utils.Objects

Assembly

Utils.dll

Represents a discriminated union that can hold a value of T1, T2, T3, T4 or T5.

public readonly struct OneOf<T1, T2, T3, T4, T5> : IEqualityOperators<OneOf<T1, T2, T3, T4, T5>, OneOf<T1, T2, T3, T4, T5>, bool>

Type Parameters

T1

The first possible value type.

T2

The second possible value type.

T3

The third possible value type.

T4

The fourth possible value type.

T5

The fifth possible value type.

Implements

IEqualityOperators<OneOf<T1, T2, T3, T4, T5>, OneOf<T1, T2, T3, T4, T5>, bool>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

DataUtils.ToDbValue(object?)

MathEx.Clamp<T>(T, T, T, IComparer<T>)

FluentExtensions.Failure<T>(T)

FluentExtensions.IsEqualTo<T, CT>(T, CT)

FluentExtensions.IsGreaterOrEqualsThan<T, CT>(T, CT)

FluentExtensions.IsGreaterThan<T, CT>(T, CT)

FluentExtensions.IsIn<T>(T, params T[])

FluentExtensions.IsLowerOrEqualsThan<T, CT>(T, CT)

FluentExtensions.IsLowerThan<T, CT>(T, CT)

FluentExtensions.IsNotIn<T>(T, params T[])

FluentExtensions.IsNotNull<T>(T)

FluentExtensions.IsNull<T>(T)

FluentExtensions.Success<T>(T)

FluentExtensions.Test<T>(T, Func<T, bool>)

ObjectUtils.Between<T>(T, IComparer<T>, T, T)

ObjectUtils.Between<T>(T, IComparer<T>, T, T, bool, bool)

ObjectUtils.DoAsync<T, Result>(T, Func<T, Task<Result>>, Func<Task<Result>>)

ObjectUtils.DoAsync<T, Result>(T, Func<T, Task<Result>>, Result)

ObjectUtils.DoAsync<T, Result>(T, Func<T, Result>, Func<Result>)

ObjectUtils.DoAsync<T, Result>(T, Func<T, Result>, Result)

ObjectUtils.Do<T, Result>(T, Func<T, Result>, Func<Result>)

ObjectUtils.Do<T, Result>(T, Func<T, Result>, Result)

ObjectUtils.In<T>(T, params T[])

ObjectUtils.NotIn<T>(T, params T[])

Validations.ArgMustBe<T>(T, Func<T, bool>, string, string)

Validations.ArgMustNotBe<T>(T, Func<T, bool>, string, string)

Validations.Arg<T>(T, string)

Validations.Variable<T>(T, string)

Methods

Equals(object?)

Determines whether the stored value equals the specified object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the stored value.

Returns

bool

true when the stored value equals obj; otherwise, false.

GetHashCode()

Returns the hash code of the stored value.

public override int GetHashCode()

Returns

int

The hash code of the stored value, or 0 when no value is stored.

Switch(Action<T1>, Action<T2>, Action<T3>, Action<T4>, Action<T5>)

Executes one of the provided actions depending on the stored value type.

public void Switch(Action<T1> action1, Action<T2> action2, Action<T3> action3, Action<T4> action4, Action<T5> action5)

Parameters

action1 Action<T1>

The action to invoke when the stored value is of type T1.

action2 Action<T2>

The action to invoke when the stored value is of type T2.

action3 Action<T3>

The action to invoke when the stored value is of type T3.

action4 Action<T4>

The action to invoke when the stored value is of type T4.

action5 Action<T5>

The action to invoke when the stored value is of type T5.

Switch<T>(Func<T1, T>, Func<T2, T>, Func<T3, T>, Func<T4, T>, Func<T5, T>)

Projects the stored value using the provided functions.

public T Switch<T>(Func<T1, T> func1, Func<T2, T> func2, Func<T3, T> func3, Func<T4, T> func4, Func<T5, T> func5)

Parameters

func1 Func<T1, T>

The function to use when the stored value is of type T1.

func2 Func<T2, T>

The function to use when the stored value is of type T2.

func3 Func<T3, T>

The function to use when the stored value is of type T3.

func4 Func<T4, T>

The function to use when the stored value is of type T4.

func5 Func<T5, T>

The function to use when the stored value is of type T5.

Returns

T

The result produced by the matching projection function, or the default value of T when the corresponding function is null.

Type Parameters

T

The return type of the projection.

ToString()

Returns a string representation of the stored value.

public override string ToString()

Returns

string

The result of calling ToString() on the stored value, or Empty when no value is stored.

Operators

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

Determines whether two instances store equal values.

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

Parameters

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

The first instance to compare.

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

The second instance to compare.

Returns

bool

true when both instances store equal values; otherwise, false.

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

Retrieves the stored T1 value.

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

Parameters

oo OneOf<T1, T2, T3, T4, T5>

The union to convert.

Returns

T1

The stored value when it is of type T1.

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

Retrieves the stored T2 value.

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

Parameters

oo OneOf<T1, T2, T3, T4, T5>

The union to convert.

Returns

T2

The stored value when it is of type T2.

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

Retrieves the stored T3 value.

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

Parameters

oo OneOf<T1, T2, T3, T4, T5>

The union to convert.

Returns

T3

The stored value when it is of type T3.

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

Retrieves the stored T4 value.

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

Parameters

oo OneOf<T1, T2, T3, T4, T5>

The union to convert.

Returns

T4

The stored value when it is of type T4.

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

Retrieves the stored T5 value.

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

Parameters

oo OneOf<T1, T2, T3, T4, T5>

The union to convert.

Returns

T5

The stored value when it is of type T5.

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

Creates a OneOf<T1, T2, T3, T4, T5> from a T1 value.

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

Parameters

o T1

The value to wrap.

Returns

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

A OneOf<T1, T2, T3, T4, T5> instance storing o.

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

Creates a OneOf<T1, T2, T3, T4, T5> from a T2 value.

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

Parameters

o T2

The value to wrap.

Returns

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

A OneOf<T1, T2, T3, T4, T5> instance storing o.

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

Creates a OneOf<T1, T2, T3, T4, T5> from a T3 value.

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

Parameters

o T3

The value to wrap.

Returns

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

A OneOf<T1, T2, T3, T4, T5> instance storing o.

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

Creates a OneOf<T1, T2, T3, T4, T5> from a T4 value.

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

Parameters

o T4

The value to wrap.

Returns

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

A OneOf<T1, T2, T3, T4, T5> instance storing o.

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

Creates a OneOf<T1, T2, T3, T4, T5> from a T5 value.

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

Parameters

o T5

The value to wrap.

Returns

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

A OneOf<T1, T2, T3, T4, T5> instance storing o.

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

Determines whether two instances store different values.

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

Parameters

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

The first instance to compare.

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

The second instance to compare.

Returns

bool

true when the instances store different values; otherwise, false.