BadScript 2
Loading...
Searching...
No Matches
RailwaySharp.ErrorHandling.Ok< TSuccess, TMessage > Class Template Referencesealed

Represents the result of a successful computation. More...

Inheritance diagram for RailwaySharp.ErrorHandling.Ok< TSuccess, TMessage >:
RailwaySharp.ErrorHandling.Result< TSuccess, TMessage >

Public Member Functions

 Ok (TSuccess success, IEnumerable< TMessage > messages)
 
- Public Member Functions inherited from RailwaySharp.ErrorHandling.Result< TSuccess, TMessage >
override string ToString ()
 

Properties

TSuccess Success [get]
 
IEnumerable< TMessage > Messages [get]
 
- Properties inherited from RailwaySharp.ErrorHandling.Result< TSuccess, TMessage >
ResultType Tag [get]
 

Private Attributes

readonly Tuple< TSuccess, IEnumerable< TMessage > > _value
 

Additional Inherited Members

- Static Public Member Functions inherited from RailwaySharp.ErrorHandling.Result< TSuccess, TMessage >
static Result< TSuccess, TMessage > FailWith< TSuccess, TMessage > (IEnumerable< TMessage > messages)
 Creates a Failure result with the given messages.
 
static Result< TSuccess, TMessage > FailWith< TSuccess, TMessage > (TMessage message)
 Creates a Failure result with the given message.
 
static Result< TSuccess, TMessage > Succeed< TSuccess, TMessage > (TSuccess value)
 Creates a Success result with the given value.
 
static Result< TSuccess, TMessage > Succeed< TSuccess, TMessage > (TSuccess value, TMessage message)
 Creates a Success result with the given value and the given message.
 
static Result< TSuccess, TMessage > Succeed< TSuccess, TMessage > (TSuccess value, IEnumerable< TMessage > messages)
 Creates a Success result with the given value and the given messages.
 
static Result< TSuccess, Exception > Try< TSuccess > (Func< TSuccess > func)
 Executes the given function on a given success or captures the failure.
 
- Protected Member Functions inherited from RailwaySharp.ErrorHandling.Result< TSuccess, TMessage >
 Result (ResultType tag)
 

Detailed Description

Represents the result of a successful computation.

Template Parameters
TSuccessType that models the result of a successful computation.
TMessageType that model a message related to a computation.

Definition at line 70 of file ErrorHandling.cs.

Constructor & Destructor Documentation

◆ Ok()

RailwaySharp.ErrorHandling.Ok< TSuccess, TMessage >.Ok ( TSuccess  success,
IEnumerable< TMessage >  messages 
)

Definition at line 74 of file ErrorHandling.cs.

75 : base(ResultType.Ok)
76 {
77 if (messages == null)
78 {
79 throw new ArgumentNullException(nameof(messages));
80 }
81
82 _value = Tuple.Create(success, messages);
83 }
readonly Tuple< TSuccess, IEnumerable< TMessage > > _value

Member Data Documentation

◆ _value

readonly Tuple<TSuccess, IEnumerable<TMessage> > RailwaySharp.ErrorHandling.Ok< TSuccess, TMessage >._value
private

Definition at line 72 of file ErrorHandling.cs.

Property Documentation

◆ Messages

IEnumerable<TMessage> RailwaySharp.ErrorHandling.Ok< TSuccess, TMessage >.Messages
get

Definition at line 87 of file ErrorHandling.cs.

◆ Success

TSuccess RailwaySharp.ErrorHandling.Ok< TSuccess, TMessage >.Success
get

Definition at line 85 of file ErrorHandling.cs.


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