RailwaySharp.ErrorHandling.Result< TSuccess, TMessage > Class Template Reference

Represents the result of a computation. More...

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

Public Member Functions
override string	ToString ()

Static Public Member Functions
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
	Result (ResultType tag)

Properties
ResultType	Tag [get]

Detailed Description

Represents the result of a computation.

Template Parameters

TSuccess	Type that models the result of a successful computation.
TMessage	Type that model a message related to a computation.

Definition at line 32 of file ErrorHandling.cs.

Constructor & Destructor Documentation

Result()

RailwaySharp.ErrorHandling.Result< TSuccess, TMessage >.Result ( ResultType  tag )

protected

Definition at line 34 of file ErrorHandling.cs.

        {
            Tag = tag;
        }

Member Function Documentation

FailWith< TSuccess, TMessage >() [1/2]

static Result< TSuccess, TMessage > RailwaySharp.ErrorHandling.Result< TSuccess, TMessage >.FailWith< TSuccess, TMessage > ( IEnumerable< TMessage >  messages )

static

Creates a Failure result with the given messages.

Definition at line 122 of file ErrorHandling.cs.

        {
            if (messages == null)
            {
                throw new ArgumentException(nameof(messages));
            }
 
            return new Bad<TSuccess, TMessage>(messages);
        }

FailWith< TSuccess, TMessage >() [2/2]

static Result< TSuccess, TMessage > RailwaySharp.ErrorHandling.Result< TSuccess, TMessage >.FailWith< TSuccess, TMessage > ( TMessage  message )

static

Creates a Failure result with the given message.

Definition at line 135 of file ErrorHandling.cs.

        {
            if (message == null)
            {
                throw new ArgumentException(nameof(message));
            }
 
            return new Bad<TSuccess, TMessage>(new[] { message });
        }

Succeed< TSuccess, TMessage >() [1/3]

static Result< TSuccess, TMessage > RailwaySharp.ErrorHandling.Result< TSuccess, TMessage >.Succeed< TSuccess, TMessage > ( TSuccess  value )

static

Creates a Success result with the given value.

Definition at line 148 of file ErrorHandling.cs.

        {
            return new Ok<TSuccess, TMessage>(value, Enumerable.Empty<TMessage>());
        }

Succeed< TSuccess, TMessage >() [2/3]

static Result< TSuccess, TMessage > RailwaySharp.ErrorHandling.Result< TSuccess, TMessage >.Succeed< TSuccess, TMessage > ( TSuccess  value, IEnumerable< TMessage >  messages  )

static

Creates a Success result with the given value and the given messages.

Definition at line 171 of file ErrorHandling.cs.

        {
            if (messages == null)
            {
                throw new ArgumentException(nameof(messages));
            }
 
            return new Ok<TSuccess, TMessage>(value, messages);
        }

Succeed< TSuccess, TMessage >() [3/3]

static Result< TSuccess, TMessage > RailwaySharp.ErrorHandling.Result< TSuccess, TMessage >.Succeed< TSuccess, TMessage > ( TSuccess  value, TMessage  message  )

static

Creates a Success result with the given value and the given message.

Definition at line 156 of file ErrorHandling.cs.

        {
            if (message == null)
            {
                throw new ArgumentException(nameof(message));
            }
 
            return new Ok<TSuccess, TMessage>(value,
                                              new[] { message }
                                             );
        }

ToString()

override string RailwaySharp.ErrorHandling.Result< TSuccess, TMessage >.ToString

(

)

Definition at line 41 of file ErrorHandling.cs.

        {
            switch (Tag)
            {
                default:
                    Ok<TSuccess, TMessage> ok = (Ok<TSuccess, TMessage>)this;
 
                    return string.Format("OK: {0} - {1}",
                                         ok.Success,
                                         string.Join(Environment.NewLine, ok.Messages.Select(v => v.ToString()))
                                        );
                case ResultType.Bad:
                    Bad<TSuccess, TMessage> bad = (Bad<TSuccess, TMessage>)this;
 
                    return string.Format("Error: {0}",
                                         string.Join(Environment.NewLine, bad.Messages.Select(v => v.ToString()))
                                        );
            }
        }

Try< TSuccess >()

static Result< TSuccess, Exception > RailwaySharp.ErrorHandling.Result< TSuccess, TMessage >.Try< TSuccess > ( Func< TSuccess >  func )

static

Executes the given function on a given success or captures the failure.

Definition at line 186 of file ErrorHandling.cs.

        {
            if (func == null)
            {
                throw new ArgumentException(nameof(func));
            }
 
            try
            {
                return new Ok<TSuccess, Exception>(func(),
                                                   Enumerable.Empty<Exception>()
                                                  );
            }
            catch (Exception ex)
            {
                return new Bad<TSuccess, Exception>(new[] { ex });
            }
        }

Property Documentation

Tag

ResultType RailwaySharp.ErrorHandling.Result< TSuccess, TMessage >.Tag

get

Definition at line 39 of file ErrorHandling.cs.

{ get; }

---

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

• deps/commandlineparser/src/CommandLine/Infrastructure/ErrorHandling.cs