FileSurfer.Models.SimpleResult Class Reference

An immutable, lightweight, and memory efficient implementation of IResult that supports at most one error message. More...

Inheritance diagram for FileSurfer.Models.SimpleResult:

Collaboration diagram for FileSurfer.Models.SimpleResult:

Static Public Member Functions
static SimpleResult	Ok ()
static SimpleResult	Error ()
static SimpleResult	Error (string errorMessage)

Properties
bool	IsOk [get]
	Value indicating whether the operation was successful.
IEnumerable< string >	Errors [get]
	Collection of error messages describing why the operation failed.

Private Member Functions
	SimpleResult (bool isOk, string? errorMessage)

Static Private Member Functions
static IEnumerable< string >	GetEnumerable (string errorMessage)

Private Attributes
readonly? IEnumerable< string >	_errors

Static Private Attributes
static readonly IEnumerable< string >	EmptyEnumerable = Enumerable.Empty<string>()
static readonly SimpleResult	OkResult = new(true, null)
static readonly SimpleResult	ErrorEmptyResult = new(false, null)

Detailed Description

An immutable, lightweight, and memory efficient implementation of IResult that supports at most one error message.

Constructor & Destructor Documentation

SimpleResult()

FileSurfer.Models.SimpleResult.SimpleResult ( bool isOk, string? errorMessage )

inlineprivate

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

Error() [1/2]

SimpleResult FileSurfer.Models.SimpleResult.Error ( )

static

Here is the call graph for this function:

Here is the caller graph for this function:

Error() [2/2]

SimpleResult FileSurfer.Models.SimpleResult.Error ( string errorMessage )

static

Here is the call graph for this function:

GetEnumerable()

IEnumerable< string > FileSurfer.Models.SimpleResult.GetEnumerable ( string errorMessage )

inlinestaticprivate

Here is the caller graph for this function:

Ok()

SimpleResult FileSurfer.Models.SimpleResult.Ok ( )

static

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_errors

readonly? IEnumerable<string> FileSurfer.Models.SimpleResult._errors

private

EmptyEnumerable

readonly IEnumerable<string> FileSurfer.Models.SimpleResult.EmptyEnumerable = Enumerable.Empty<string>()

staticprivate

ErrorEmptyResult

readonly SimpleResult FileSurfer.Models.SimpleResult.ErrorEmptyResult = new(false, null)

staticprivate

OkResult

readonly SimpleResult FileSurfer.Models.SimpleResult.OkResult = new(true, null)

staticprivate

Property Documentation

Errors

IEnumerable<string> FileSurfer.Models.SimpleResult.Errors

get

Collection of error messages describing why the operation failed.

Empty if the operation succeeded.

Implements FileSurfer.Models.IResult.

IsOk

bool FileSurfer.Models.SimpleResult.IsOk

get

Value indicating whether the operation was successful.

Implements FileSurfer.Models.IResult.

---

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

• D:/PROJECTS/FileSurfer/src/FileSurfer/Models/IResult.cs