Class ReturnValue<T, E>

Namespace

Utils.Objects

Assembly

Utils.dll

Represents an operation result that can contain either a value or an error object.

public class ReturnValue<T, E> where E : class

Type Parameters

T

Type of the returned value.

E

Type of the returned error.

Inheritance

object

ReturnValue<T, E>

Derived

ReturnValue<T>

ReturnValue<T>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

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.ValueMustNotBeNull<T>(T, string)

Validations.Variable<T>(T, string)

Constructors

ReturnValue(T)

Initializes a successful ReturnValue<T, E> instance that carries a value.

public ReturnValue(T value)

Parameters

value T

The value produced by the operation.

ReturnValue(E)

Initializes an error ReturnValue<T, E> instance that carries an error object.

public ReturnValue(E error)

Parameters

error E

The error produced by the operation.

Properties

Error

Gets the error associated with the operation when IsError is true.

public E Error { get; }

Property Value

E

IsError

Gets a value indicating whether the operation captured an error.

public bool IsError { get; }

Property Value

bool

IsSuccess

Gets a value indicating whether the operation was successful.

public bool IsSuccess { get; }

Property Value

bool

Value

Gets the value returned by the operation.

public T Value { get; }

Property Value

T

Methods

Do(Action<T>, Action<E>)

Executes the appropriate callback depending on whether the instance represents success or failure.

public void Do(Action<T> onSuccess, Action<E> onError)

Parameters

onSuccess Action<T>

Callback executed when IsSuccess is true.

onError Action<E>

Callback executed when IsError is true.

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.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Operators

implicit operator T(ReturnValue<T, E>)

Extracts the value stored inside a ReturnValue<T, E>.

public static implicit operator T(ReturnValue<T, E> rv)

Parameters

rv ReturnValue<T, E>

The ReturnValue<T, E> to extract the value from.

Returns

T

The contained value.

implicit operator E(ReturnValue<T, E>)

Extracts the error stored inside a ReturnValue<T, E>.

public static implicit operator E(ReturnValue<T, E> rv)

Parameters

rv ReturnValue<T, E>

The ReturnValue<T, E> to extract the error from.

Returns

E

The contained error.

implicit operator ReturnValue<T, E>(T)

Creates a successful ReturnValue<T, E> from a value.

public static implicit operator ReturnValue<T, E>(T value)

Parameters

value T

The value to wrap.

Returns

ReturnValue<T, E>