FileSurfer.Core.Models.ValueResult< T > Class Template Reference

An immutable, lightweight, and memory efficient implementation of IResult that extends SimpleResult and includes a value if IsOk is true
Supports at most one error message. More...

Inheritance diagram for FileSurfer.Core.Models.ValueResult< T >:

Collaboration diagram for FileSurfer.Core.Models.ValueResult< T >:

Static Public Member Functions
static ValueResult< T >	Ok (T value)
	Creates a successful result with the provided value.
static ValueResult< T >	Error ()
	Gets a cached failed result with no error message.
static ValueResult< T >	Error (IResult result)
	Creates a failed value result from another failed result.
static ValueResult< T >	Error (string errorMessage)
	Creates a failed result with a single error message.

Properties
bool	IsOk [get]
	Value indicating whether the operation was successful.
IEnumerable< string >	Errors [get]
	Collection of error messages describing why the operation failed.
T	Value [get]
	Gets the result value when IsOk is true.

Detailed Description

An immutable, lightweight, and memory efficient implementation of IResult that extends SimpleResult and includes a value if IsOk is true
Supports at most one error message.

Member Function Documentation

Error() [1/3]

ValueResult< T > FileSurfer.Core.Models.ValueResult< T >.Error ( )

inlinestatic

Gets a cached failed result with no error message.

Returns

Failed ValueResult<T> without error details.

Here is the caller graph for this function:

Error() [2/3]

ValueResult< T > FileSurfer.Core.Models.ValueResult< T >.Error ( IResult result )

inlinestatic

Creates a failed value result from another failed result.

Parameters

result

Source failed result to copy errors from.

Returns

Failed ValueResult<T> with errors copied from result .

Exceptions

InvalidOperationException

Thrown when result is successful.

Error() [3/3]

ValueResult< T > FileSurfer.Core.Models.ValueResult< T >.Error ( string errorMessage )

inlinestatic

Creates a failed result with a single error message.

Parameters

errorMessage

Error message describing the failure.

Returns

Failed ValueResult<T> containing the provided error.

Ok()

ValueResult< T > FileSurfer.Core.Models.ValueResult< T >.Ok ( T value )

inlinestatic

Creates a successful result with the provided value.

Parameters

value

Value to store in the successful result.

Returns

Successful ValueResult<T> containing value .

Property Documentation

Errors

IEnumerable<string> FileSurfer.Core.Models.ValueResult< T >.Errors

get

Collection of error messages describing why the operation failed.

Empty if the operation succeeded.

Implements FileSurfer.Core.Models.IResult.

IsOk

bool FileSurfer.Core.Models.ValueResult< T >.IsOk

get

Value indicating whether the operation was successful.

Implements FileSurfer.Core.Models.IResult.

Value

T FileSurfer.Core.Models.ValueResult< T >.Value

get

Gets the result value when IsOk is true.

Exceptions

InvalidOperationException

Thrown when the result is not successful.

---

The documentation for this class was generated from the following file:

• /home/janecea/Documents/CODE/PROJECTS/FileSurfer/src/FileSurfer.Core/Models/IResult.cs