Class Result<TValue>

Namespace

Compendium.Core.Results

Assembly

Compendium.Core.dll

Represents the result of an operation that can either succeed with a value or fail.

public sealed class Result<TValue> : Result

Type Parameters

TValue

The type of the value returned on success.

Inheritance

object

Result

Result<TValue>

Inherited Members

Result.IsSuccess

Result.IsFailure

Result.Error

Result.Success()

Result.Success<TValue>(TValue)

Result.Failure(Error)

Result.Failure<TValue>(Error)

Result.Create(bool, Error)

Result.Create<TValue>(TValue, Error)

Result.Create<TValue>(TValue?, Error)

Result.Combine(params Result[])

Result.Combine(IEnumerable<Result>)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

ResultExtensions.Map<TValue>(Result, TValue)

ResultExtensions.Bind<TValue, TNewValue>(Result<TValue>, Func<TValue, Result<TNewValue>>)

ResultExtensions.Map<TValue, TNewValue>(Result<TValue>, Func<TValue, TNewValue>)

ResultExtensions.Match<TValue>(Result<TValue>, Action<TValue>, Action<Error>)

ResultExtensions.Match<TValue, TResult>(Result<TValue>, Func<TValue, TResult>, Func<Error, TResult>)

ResultExtensions.TapError<TValue>(Result<TValue>, Action<Error>)

ResultExtensions.Tap<TValue>(Result<TValue>, Action<TValue>)

Properties

Value

Gets the value of the result.

public TValue Value { get; }

Property Value

TValue

Exceptions

InvalidOperationException

Thrown when accessing the value of a failed result.

Methods

ToString()

Returns a string representation of the result.

public override string ToString()

Returns

string

A string that represents the current result.

Operators

implicit operator Result<TValue>(Error)

Implicitly converts an Error to a failed Result.

public static implicit operator Result<TValue>(Error error)

Parameters

error Error

The error.

Returns

Result<TValue>

implicit operator Result<TValue>(TValue)

Implicitly converts a value to a successful Result.

public static implicit operator Result<TValue>(TValue value)

Parameters

value TValue

The value.

Returns

Result<TValue>