RailwaySharp.ErrorHandling.ResultExtensions Class Reference

Extensions methods for easier usage. More...

Static Public Member Functions
static void	Match< TSuccess, TMessage > (this Result< TSuccess, TMessage > result, Action< TSuccess, IEnumerable< TMessage > > ifSuccess, Action< IEnumerable< TMessage > > ifFailure)
	Allows pattern matching on Results.
static TResult	Either< TSuccess, TMessage, TResult > (this Result< TSuccess, TMessage > result, Func< TSuccess, IEnumerable< TMessage >, TResult > ifSuccess, Func< IEnumerable< TMessage >, TResult > ifFailure)
	Allows pattern matching on Results.
static Result< TResult, TMessage >	Map< TSuccess, TMessage, TResult > (this Result< TSuccess, TMessage > result, Func< TSuccess, TResult > func)
	Lifts a Func into a Result and applies it on the given result.
static Result< IEnumerable< TSuccess >, TMessage >	Collect< TSuccess, TMessage > (this IEnumerable< Result< TSuccess, TMessage > > values)
	Collects a sequence of Results and accumulates their values. If the sequence contains an error the error will be propagated.
static Result< IEnumerable< TSuccess >, TMessage >	Flatten< TSuccess, TMessage > (this Result< IEnumerable< Result< TSuccess, TMessage > >, TMessage > result)
	Collects a sequence of Results and accumulates their values. If the sequence contains an error the error will be propagated.
static Result< TResult, TMessage >	SelectMany< TSuccess, TMessage, TResult > (this Result< TSuccess, TMessage > result, Func< TSuccess, Result< TResult, TMessage > > func)
	If the result is a Success it executes the given Func on the value. Otherwise the exisiting failure is propagated.
static Result< TResult, TMessage >	SelectMany< TSuccess, TMessage, TValue, TResult > (this Result< TSuccess, TMessage > result, Func< TSuccess, Result< TValue, TMessage > > func, Func< TSuccess, TValue, TResult > mapperFunc)
	If the result is a Success it executes the given Func on the value. If the result of the Func is a Success it maps it using the given Func. Otherwise the exisiting failure is propagated.
static Result< TResult, TMessage >	Select< TSuccess, TMessage, TResult > (this Result< TSuccess, TMessage > result, Func< TSuccess, TResult > func)
	Lifts a Func into a Result and applies it on the given result.
static IEnumerable< TMessage >	FailedWith< TSuccess, TMessage > (this Result< TSuccess, TMessage > result)
	Returns the error messages or fails if the result was a success.
static TSuccess	SucceededWith< TSuccess, TMessage > (this Result< TSuccess, TMessage > result)
	Returns the result or fails if the result was an error.
static IEnumerable< TMessage >	SuccessMessages< TSuccess, TMessage > (this Result< TSuccess, TMessage > result)
	Returns messages in case of success, otherwise an empty sequence.

Detailed Description

Extensions methods for easier usage.

Definition at line 547 of file ErrorHandling.cs.

Member Function Documentation

Collect< TSuccess, TMessage >()

static Result< IEnumerable< TSuccess >, TMessage > RailwaySharp.ErrorHandling.ResultExtensions.Collect< TSuccess, TMessage > ( this IEnumerable< Result< TSuccess, TMessage > >  values )

static

Collects a sequence of Results and accumulates their values. If the sequence contains an error the error will be propagated.

Definition at line 615 of file ErrorHandling.cs.

        {
            return Trial.Collect(values);
        }

Either< TSuccess, TMessage, TResult >()

static TResult RailwaySharp.ErrorHandling.ResultExtensions.Either< TSuccess, TMessage, TResult > ( this Result< TSuccess, TMessage >  result, Func< TSuccess, IEnumerable< TMessage >, TResult >  ifSuccess, Func< IEnumerable< TMessage >, TResult >  ifFailure  )

static

Allows pattern matching on Results.

Definition at line 588 of file ErrorHandling.cs.

        {
            return Trial.Either(ifSuccess, ifFailure, result);
        }

FailedWith< TSuccess, TMessage >()

static IEnumerable< TMessage > RailwaySharp.ErrorHandling.ResultExtensions.FailedWith< TSuccess, TMessage > ( this Result< TSuccess, TMessage >  result )

static

Returns the error messages or fails if the result was a success.

Definition at line 724 of file ErrorHandling.cs.

        {
            if (result.Tag == ResultType.Ok)
            {
                Ok<TSuccess, TMessage> ok = (Ok<TSuccess, TMessage>)result;
 
                throw new Exception(string.Format("Result was a success: {0} - {1}",
                                                  ok.Success,
                                                  string.Join(Environment.NewLine,
                                                              ok.Messages.Select(m => m.ToString())
                                                             )
                                                 )
                                   );
            }
 
            Bad<TSuccess, TMessage> bad = (Bad<TSuccess, TMessage>)result;
 
            return bad.Messages;
        }

Flatten< TSuccess, TMessage >()

static Result< IEnumerable< TSuccess >, TMessage > RailwaySharp.ErrorHandling.ResultExtensions.Flatten< TSuccess, TMessage > ( this Result< IEnumerable< Result< TSuccess, TMessage > >, TMessage >  result )

static

Collects a sequence of Results and accumulates their values. If the sequence contains an error the error will be propagated.

Definition at line 628 of file ErrorHandling.cs.

        {
            if (result.Tag == ResultType.Ok)
            {
                Ok<IEnumerable<Result<TSuccess, TMessage>>, TMessage> ok =
                    (Ok<IEnumerable<Result<TSuccess, TMessage>>, TMessage>)result;
                IEnumerable<Result<TSuccess, TMessage>> values = ok.Success;
                Result<IEnumerable<TSuccess>, TMessage> result1 = Collect(values);
 
                if (result1.Tag == ResultType.Ok)
                {
                    Ok<IEnumerable<TSuccess>, TMessage> ok1 = (Ok<IEnumerable<TSuccess>, TMessage>)result1;
 
                    return new Ok<IEnumerable<TSuccess>, TMessage>(ok1.Success, ok1.Messages);
                }
 
                Bad<IEnumerable<TSuccess>, TMessage> bad1 = (Bad<IEnumerable<TSuccess>, TMessage>)result1;
 
                return new Bad<IEnumerable<TSuccess>, TMessage>(bad1.Messages);
            }
 
            Bad<IEnumerable<Result<TSuccess, TMessage>>, TMessage> bad =
                (Bad<IEnumerable<Result<TSuccess, TMessage>>, TMessage>)result;
 
            return new Bad<IEnumerable<TSuccess>, TMessage>(bad.Messages);
        }

Map< TSuccess, TMessage, TResult >()

static Result< TResult, TMessage > RailwaySharp.ErrorHandling.ResultExtensions.Map< TSuccess, TMessage, TResult > ( this Result< TSuccess, TMessage >  result, Func< TSuccess, TResult >  func  )

static

Lifts a Func into a Result and applies it on the given result.

Definition at line 602 of file ErrorHandling.cs.

        {
            return Trial.Lift(func, result);
        }

Match< TSuccess, TMessage >()

static void RailwaySharp.ErrorHandling.ResultExtensions.Match< TSuccess, TMessage > ( this Result< TSuccess, TMessage >  result, Action< TSuccess, IEnumerable< TMessage > >  ifSuccess, Action< IEnumerable< TMessage > >  ifFailure  )

static

Allows pattern matching on Results.

Definition at line 555 of file ErrorHandling.cs.

        {
            if (ifSuccess == null)
            {
                throw new ArgumentException(nameof(ifSuccess));
            }
 
            if (ifFailure == null)
            {
                throw new ArgumentException(nameof(ifFailure));
            }
 
            Ok<TSuccess, TMessage> ok = result as Ok<TSuccess, TMessage>;
 
            if (ok != null)
            {
                ifSuccess(ok.Success, ok.Messages);
 
                return;
            }
 
            Bad<TSuccess, TMessage> bad = (Bad<TSuccess, TMessage>)result;
            ifFailure(bad.Messages);
        }

Select< TSuccess, TMessage, TResult >()

static Result< TResult, TMessage > RailwaySharp.ErrorHandling.ResultExtensions.Select< TSuccess, TMessage, TResult > ( this Result< TSuccess, TMessage >  result, Func< TSuccess, TResult >  func  )

static

Lifts a Func into a Result and applies it on the given result.

Definition at line 711 of file ErrorHandling.cs.

        {
            return Trial.Lift(func, result);
        }

SelectMany< TSuccess, TMessage, TResult >()

static Result< TResult, TMessage > RailwaySharp.ErrorHandling.ResultExtensions.SelectMany< TSuccess, TMessage, TResult > ( this Result< TSuccess, TMessage >  result, Func< TSuccess, Result< TResult, TMessage > >  func  )

static

If the result is a Success it executes the given Func on the value. Otherwise the exisiting failure is propagated.

Definition at line 663 of file ErrorHandling.cs.

        {
            return Trial.Bind(func, result);
        }

SelectMany< TSuccess, TMessage, TValue, TResult >()

static Result< TResult, TMessage > RailwaySharp.ErrorHandling.ResultExtensions.SelectMany< TSuccess, TMessage, TValue, TResult > ( this Result< TSuccess, TMessage >  result, Func< TSuccess, Result< TValue, TMessage > >  func, Func< TSuccess, TValue, TResult >  mapperFunc  )

static

If the result is a Success it executes the given Func on the value. If the result of the Func is a Success it maps it using the given Func. Otherwise the exisiting failure is propagated.

Definition at line 678 of file ErrorHandling.cs.

        {
            if (func == null)
            {
                throw new ArgumentException(nameof(func));
            }
 
            if (mapperFunc == null)
            {
                throw new ArgumentException(nameof(mapperFunc));
            }
 
            Func<TSuccess, Func<TValue, TResult>> curriedMapper = suc => val => mapperFunc(suc, val);
 
            Func<
                Result<TSuccess, TMessage>,
                Result<TValue, TMessage>,
                Result<TResult, TMessage>
            > liftedMapper = (a, b) => Trial.Lift2(curriedMapper, a, b);
            Result<TValue, TMessage> v = Trial.Bind(func, result);
 
            return liftedMapper(result, v);
        }

SucceededWith< TSuccess, TMessage >()

static TSuccess RailwaySharp.ErrorHandling.ResultExtensions.SucceededWith< TSuccess, TMessage > ( this Result< TSuccess, TMessage >  result )

static

Returns the result or fails if the result was an error.

Definition at line 750 of file ErrorHandling.cs.

        {
            if (result.Tag == ResultType.Ok)
            {
                Ok<TSuccess, TMessage> ok = (Ok<TSuccess, TMessage>)result;
 
                return ok.Success;
            }
 
            Bad<TSuccess, TMessage> bad = (Bad<TSuccess, TMessage>)result;
 
            throw new Exception(string.Format("Result was an error: {0}",
                                              string.Join(Environment.NewLine, bad.Messages.Select(m => m.ToString()))
                                             )
                               );
        }

SuccessMessages< TSuccess, TMessage >()

static IEnumerable< TMessage > RailwaySharp.ErrorHandling.ResultExtensions.SuccessMessages< TSuccess, TMessage > ( this Result< TSuccess, TMessage >  result )

static

Returns messages in case of success, otherwise an empty sequence.

Definition at line 770 of file ErrorHandling.cs.

        {
            if (result.Tag == ResultType.Ok)
            {
                Ok<TSuccess, TMessage> ok = (Ok<TSuccess, TMessage>)result;
 
                return ok.Messages;
            }
 
            return Enumerable.Empty<TMessage>();
        }

---

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

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