Interface IResultFailure

Namespace

Vonage.Common.Failures

Assembly

Vonage.dll

Represents a Failure with an error message.

public interface IResultFailure

Examples

// Handling failures from Result
Result<string> result = GetResult();
result.Match(
    value => Console.WriteLine($"Success: {value}"),
    failure => Console.WriteLine($"Failed: {failure.GetFailureMessage()}")
);

Properties

Type

The type of failure.

Type Type { get; }

Property Value

Type

Methods

GetFailureMessage()

Returns the error message defined in the failure.

string GetFailureMessage()

Returns

string

The error message.

Examples

IResultFailure failure = ResultFailure.FromErrorMessage("Invalid input");
string message = failure.GetFailureMessage(); // "Invalid input"

ToException()

Converts the failure to an exception.

Exception ToException()

Returns

Exception

The exception.

Examples

IResultFailure failure = ResultFailure.FromErrorMessage("Operation failed");
throw failure.ToException();

ToResult<T>()

Converts the failure to a Result with a Failure state.

Result<T> ToResult<T>()

Returns

Result<T>

A Result with a Failure state.

Type Parameters

T

The underlying type of Result.

Examples

IResultFailure failure = ResultFailure.FromErrorMessage("Not found");
Result<User> result = failure.ToResult<User>();
Console.WriteLine(result.IsFailure); // true