Class Result<TResult, TError>

Namespace

Cratis.Monads

Assembly

Cratis.Fundamentals.dll

Represents the result of trying an execution that can return a result or an error.

public class Result<TResult, TError> : OneOfBase<TResult, TError>, IOneOf

Type Parameters

TResult

The result type.

TError

The error type.

Inheritance

object

OneOfBase<TResult, TError>

Result<TResult, TError>

Implements

IOneOf

Inherited Members

OneOfBase<TResult, TError>.Switch(Action<TResult>, Action<TError>)

OneOfBase<TResult, TError>.Match<TResult>(Func<TResult, TResult>, Func<TError, TResult>)

OneOfBase<TResult, TError>.TryPickT0(out TResult, out TError)

OneOfBase<TResult, TError>.TryPickT1(out TError, out TResult)

OneOfBase<TResult, TError>.Equals(object)

OneOfBase<TResult, TError>.ToString()

OneOfBase<TResult, TError>.GetHashCode()

OneOfBase<TResult, TError>.Value

OneOfBase<TResult, TError>.Index

OneOfBase<TResult, TError>.IsT0

OneOfBase<TResult, TError>.IsT1

OneOfBase<TResult, TError>.AsT0

OneOfBase<TResult, TError>.AsT1

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

MethodCalls.CallGenericMethod<TOut, T>(T, Expression<Func<T, Func<TOut>>>, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1>(T, Expression<Func<T, Func<T1, TOut>>>, T1, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1, T2>(T, Expression<Func<T, Func<T1, T2, TOut>>>, T1, T2, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1, T2, T3>(T, Expression<Func<T, Func<T1, T2, T3, TOut>>>, T1, T2, T3, params Type[])

ConverterExtensions.ConvertTo(object, Type)

ConceptExtensions.GetConceptValue(object)

ConceptExtensions.IsConcept(object)

JsonValueExtensions.ToJsonValue(object?)

ObservableExtensions.InvokeAndWrapWithSubject<TResult>(object, Func<CancellationToken, IObservable<TResult>>)

ObservableExtensions.InvokeAndWrapWithTransformSubject<TResult, TSource>(object, Func<CancellationToken, IObservable<TSource>>, Func<TSource, TResult>)

Properties

IsSuccess

Gets a value indicating whether the execution was successful, meaning it has a result.

public bool IsSuccess { get; }

Property Value

bool

Methods

Failed(TError)

Creates a failed Result<TError>.

public static Result<TResult, TError> Failed(TError error)

Parameters

error TError

The optional error.

Returns

Result<TResult, TError>

The created Result<TError>.

Success(TResult)

Creates a successful Result<TError>.

public static Result<TResult, TError> Success(TResult value)

Parameters

value TResult

The value.

Returns

Result<TResult, TError>

The created Result<TError>.

TryGetError(out TError)

Try to get the error.

public bool TryGetError(out TError error)

Parameters

error TError

The optional error.

Returns

bool

A boolean indicating whether the error was present.

TryGetResult(out TResult)

Try to get the result TResult.

public bool TryGetResult(out TResult result)

Parameters

result TResult

The result.

Returns

bool

A boolean indicating whether the result was present.

Operators

explicit operator TResult(Result<TResult, TError>)

public static explicit operator TResult(Result<TResult, TError> obj)

Parameters

obj Result<TResult, TError>

Returns

TResult

explicit operator TError(Result<TResult, TError>)

public static explicit operator TError(Result<TResult, TError> obj)

Parameters

obj Result<TResult, TError>

Returns

TError

implicit operator Result<TResult, TError>(TResult)

public static implicit operator Result<TResult, TError>(TResult value)

Parameters

value TResult

Returns

Result<TResult, TError>

implicit operator Result<TResult, TError>(TError)

public static implicit operator Result<TResult, TError>(TError error)

Parameters

error TError

Returns

Result<TResult, TError>