FileSurfer.Core.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.Core.Models.SimpleResult:

Collaboration diagram for FileSurfer.Core.Models.SimpleResult:

Static Public Member Functions
static SimpleResult	Ok ()
	Gets a cached successful result with no errors.
static SimpleResult	Error ()
	Gets a cached failed result with no error message.
static SimpleResult	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.

Detailed Description

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

Member Function Documentation

Error() [1/2]

SimpleResult FileSurfer.Core.Models.SimpleResult.Error ( )

inlinestatic

Gets a cached failed result with no error message.

Returns

Failed SimpleResult instance without error details.

Error() [2/2]

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

inlinestatic

Creates a failed result with a single error message.

Parameters

errorMessage

Error message describing the failure.

Returns

Failed SimpleResult containing the provided error message.

Ok()

SimpleResult FileSurfer.Core.Models.SimpleResult.Ok ( )

inlinestatic

Gets a cached successful result with no errors.

Returns

Successful SimpleResult instance.

Property Documentation

Errors

IEnumerable<string> FileSurfer.Core.Models.SimpleResult.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.SimpleResult.IsOk

get

Value indicating whether the operation was successful.

Implements FileSurfer.Core.Models.IResult.

---

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

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