Struct ResultFailure

Namespace

Vonage.Common.Failures

Assembly

Vonage.dll

public readonly struct ResultFailure : IResultFailure

Implements

IResultFailure

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Examples

// Create a failure from an error message
ResultFailure failure = ResultFailure.FromErrorMessage("Validation failed");
Console.WriteLine(failure.GetFailureMessage()); // "Validation failed"

// Convert to a Result
Result<int> result = failure.ToResult<int>();
Console.WriteLine(result.IsFailure); // true

Properties

Type

The type of failure.

public Type Type { get; }

Property Value

Type

Methods

FromErrorMessage(string)

Creates a failure from an error message.

public static ResultFailure FromErrorMessage(string error)

Parameters

error string

The error message.

Returns

ResultFailure

The failure.

Examples

ResultFailure failure = ResultFailure.FromErrorMessage("Email address is invalid");
Console.WriteLine(failure.GetFailureMessage()); // "Email address is invalid"

GetFailureMessage()

Returns the error message defined in the failure.

public 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.

public 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.

public 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