CSharpx.Either< TLeft, TRight > Class Template Reference

Inheritance diagram for CSharpx.Either< TLeft, TRight >:

Public Member Functions
bool	MatchLeft (out TLeft value)
bool	MatchRight (out TRight value)

Static Public Member Functions
static Either< TLeft, TResult >	Map< TLeft, TRight, TResult > (Either< TLeft, TRight > either, Func< TRight, TResult > func)
	Transforms a Either's right value by using a specified mapping function.
static Either< TLeft1, TRight1 >	Bimap< TLeft, TRight, TLeft1, TRight1 > (Either< TLeft, TRight > either, Func< TLeft, TLeft1 > mapLeft, Func< TRight, TRight1 > mapRight)
	Maps both parts of a Either type. Applies the first function if Either is Left. Otherwise applies the second function.
static TRight	GetOrFail< TLeft, TRight > (Either< TLeft, TRight > either)
	Returns a Either Right or fail with an exception.
static TLeft	GetLeftOrDefault< TLeft, TRight > (Either< TLeft, TRight > either, TLeft @default)
	Returns a Either Left or a defualt value.
static TRight	GetRightOrDefault< TLeft, TRight > (Either< TLeft, TRight > either, TRight @default)
	Returns a Either Right or a defualt value.
static Either< Exception, TRight >	Try< TRight > (Func< TRight > func)
	Wraps a function, encapsulates any exception thrown within to a Either.
static Either< Exception, TRight >	Cast< TRight > (object obj)
	Attempts to cast an object. Stores the cast value in 1Of2 if successful, otherwise stores the exception in 2Of2.
static Either< TLeft, TRight >	FromMaybe< TLeft, TRight > (Maybe< TRight > maybe, TLeft left)
static Either< TLeft, TRight >	Left< TLeft, TRight > (TLeft value)
static Either< TLeft, TRight >	Right< TLeft, TRight > (TRight value)
static Either< string, TRight >	Return< TRight > (TRight value)
	Inject a value into the Either type, returning Right case.
static Either< string, TRight >	Fail< TRight > (string message)
	Fail with a message. Not part of mathematical definition of a monad.
static Either< TLeft, TResult >	Bind< TLeft, TRight, TResult > (Either< TLeft, TRight > either, Func< TRight, Either< TLeft, TResult > > func)
	Monadic bind.
static Either< TLeft, TResult >	Select< TLeft, TRight, TResult > (this Either< TLeft, TRight > either, Func< TRight, TResult > selector)
	Map operation compatible with Linq.
static Either< TLeft, TResult >	SelectMany< TLeft, TRight, TResult > (this Either< TLeft, TRight > result, Func< TRight, Either< TLeft, TResult > > func)

Protected Member Functions
	Either (EitherType tag)

Properties
EitherType	Tag [get]

Static Private Member Functions
static TLeft	GetLeft< TLeft, TRight > (this Either< TLeft, TRight > either)

Detailed Description

Definition at line 29 of file Either.cs.

Constructor & Destructor Documentation

Either()

CSharpx.Either< TLeft, TRight >.Either ( EitherType  tag )

protected

Definition at line 31 of file Either.cs.

        {
            Tag = tag;
        }

Member Function Documentation

Bimap< TLeft, TRight, TLeft1, TRight1 >()

static Either< TLeft1, TRight1 > CSharpx.Either< TLeft, TRight >.Bimap< TLeft, TRight, TLeft1, TRight1 > ( Either< TLeft, TRight >  either, Func< TLeft, TLeft1 >  mapLeft, Func< TRight, TRight1 >  mapRight  )

static

Maps both parts of a Either type. Applies the first function if Either is Left. Otherwise applies the second function.

Definition at line 119 of file Either.cs.

        {
            TRight right;
 
            if (either.MatchRight(out right))
            {
                return Right<TLeft1, TRight1>(mapRight(right));
            }
 
            return Left<TLeft1, TRight1>(mapLeft(either.GetLeft()));
        }

Bind< TLeft, TRight, TResult >()

static Either< TLeft, TResult > CSharpx.Either< TLeft, TRight >.Bind< TLeft, TRight, TResult > ( Either< TLeft, TRight >  either, Func< TRight, Either< TLeft, TResult > >  func  )

static

Monadic bind.

Definition at line 247 of file Either.cs.

        {
            TRight right;
 
            if (either.MatchRight(out right))
            {
                return func(right);
            }
 
            return Left<TLeft, TResult>(either.GetLeft());
        }

Cast< TRight >()

static Either< Exception, TRight > CSharpx.Either< TLeft, TRight >.Cast< TRight > ( object  obj )

static

Attempts to cast an object. Stores the cast value in 1Of2 if successful, otherwise stores the exception in 2Of2.

Definition at line 190 of file Either.cs.

        {
            return Try(() => (TRight)obj);
        }

Fail< TRight >()

static Either< string, TRight > CSharpx.Either< TLeft, TRight >.Fail< TRight > ( string  message )

static

Fail with a message. Not part of mathematical definition of a monad.

Definition at line 239 of file Either.cs.

        {
            throw new Exception(message);
        }

FromMaybe< TLeft, TRight >()

static Either< TLeft, TRight > CSharpx.Either< TLeft, TRight >.FromMaybe< TLeft, TRight > ( Maybe< TRight >  maybe, TLeft  left  )

static

Definition at line 196 of file Either.cs.

        {
            if (maybe.Tag == MaybeType.Just)
            {
                return Right<TLeft, TRight>(((Just<TRight>)maybe).Value);
            }
 
            return Left<TLeft, TRight>(left);
        }

GetLeft< TLeft, TRight >()

static TLeft CSharpx.Either< TLeft, TRight >.GetLeft< TLeft, TRight > ( this Either< TLeft, TRight >  either )

staticprivate

Definition at line 207 of file Either.cs.

        {
            return ((Left<TLeft, TRight>)either).Value;
        }

GetLeftOrDefault< TLeft, TRight >()

static TLeft CSharpx.Either< TLeft, TRight >.GetLeftOrDefault< TLeft, TRight > ( Either< TLeft, TRight >  either, TLeft @  default  )

static

Returns a Either Left or a defualt value.

Definition at line 154 of file Either.cs.

        {
            TLeft value;
 
            return either.MatchLeft(out value) ? value : @default;
        }

GetOrFail< TLeft, TRight >()

static TRight CSharpx.Either< TLeft, TRight >.GetOrFail< TLeft, TRight > ( Either< TLeft, TRight >  either )

static

Returns a Either Right or fail with an exception.

Definition at line 139 of file Either.cs.

        {
            TRight value;
 
            if (either.MatchRight(out value))
            {
                return value;
            }
 
            throw new ArgumentException(nameof(either), string.Format("The either value was Left {0}", either));
        }

GetRightOrDefault< TLeft, TRight >()

static TRight CSharpx.Either< TLeft, TRight >.GetRightOrDefault< TLeft, TRight > ( Either< TLeft, TRight >  either, TRight @  default  )

static

Returns a Either Right or a defualt value.

Definition at line 164 of file Either.cs.

        {
            TRight value;
 
            return either.MatchRight(out value) ? value : @default;
        }

Left< TLeft, TRight >()

static Either< TLeft, TRight > CSharpx.Either< TLeft, TRight >.Left< TLeft, TRight > ( TLeft  value )

static

Definition at line 214 of file Either.cs.

        {
            return new Left<TLeft, TRight>(value);
        }

Map< TLeft, TRight, TResult >()

static Either< TLeft, TResult > CSharpx.Either< TLeft, TRight >.Map< TLeft, TRight, TResult > ( Either< TLeft, TRight >  either, Func< TRight, TResult >  func  )

static

Transforms a Either's right value by using a specified mapping function.

Definition at line 97 of file Either.cs.

        {
            TRight right;
 
            if (either.MatchRight(out right))
            {
                return Right<TLeft, TResult>(func(right));
            }
 
            return Left<TLeft, TResult>(either.GetLeft());
        }

MatchLeft()

bool CSharpx.Either< TLeft, TRight >.MatchLeft

(

out TLeft

value

)

Definition at line 40 of file Either.cs.

        {
            value = Tag == EitherType.Left ? ((Left<TLeft, TRight>)this).Value : default;
 
            return Tag == EitherType.Left;
        }

MatchRight()

bool CSharpx.Either< TLeft, TRight >.MatchRight

(

out TRight

value

)

Definition at line 47 of file Either.cs.

        {
            value = Tag == EitherType.Right ? ((Right<TLeft, TRight>)this).Value : default;
 
            return Tag == EitherType.Right;
        }

Return< TRight >()

static Either< string, TRight > CSharpx.Either< TLeft, TRight >.Return< TRight > ( TRight  value )

static

Inject a value into the Either type, returning Right case.

Definition at line 231 of file Either.cs.

        {
            return Right<string, TRight>(value);
        }

Right< TLeft, TRight >()

static Either< TLeft, TRight > CSharpx.Either< TLeft, TRight >.Right< TLeft, TRight > ( TRight  value )

static

Definition at line 219 of file Either.cs.

        {
            return new Right<TLeft, TRight>(value);
        }

Select< TLeft, TRight, TResult >()

static Either< TLeft, TResult > CSharpx.Either< TLeft, TRight >.Select< TLeft, TRight, TResult > ( this Either< TLeft, TRight >  either, Func< TRight, TResult >  selector  )

static

Map operation compatible with Linq.

Definition at line 268 of file Either.cs.

        {
            return Map(either, selector);
        }

SelectMany< TLeft, TRight, TResult >()

static Either< TLeft, TResult > CSharpx.Either< TLeft, TRight >.SelectMany< TLeft, TRight, TResult > ( this Either< TLeft, TRight >  result, Func< TRight, Either< TLeft, TResult > >  func  )

static

Definition at line 274 of file Either.cs.

        {
            return Bind(result, func);
        }

Try< TRight >()

static Either< Exception, TRight > CSharpx.Either< TLeft, TRight >.Try< TRight > ( Func< TRight >  func )

static

Wraps a function, encapsulates any exception thrown within to a Either.

Definition at line 174 of file Either.cs.

        {
            try
            {
                return new Right<Exception, TRight>(func());
            }
            catch (Exception ex)
            {
                return new Left<Exception, TRight>(ex);
            }
        }

Property Documentation

Tag

EitherType CSharpx.Either< TLeft, TRight >.Tag

get

Definition at line 36 of file Either.cs.

{ get; }

---

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

• deps/commandlineparser/src/CommandLine/Infrastructure/CSharpx/Either.cs