Sub modules

None

Reference version of option for use in pattern-matching

Some = result is A
None = result is null

Is the option in a Some state

Is the option in a None state

Monoid empty (aka None)

Ctor that facilitates serialisation

Uses the EqDefault instance to do an equality check on the bound value. To use anything other than the default call oa.Equals〈EqA〉(ob) where EqA is an instance derived from Eq〈A〉

This uses the EqDefault instance for comparison of the bound A values. The EqDefault instance wraps up the .NET EqualityComparer.Default behaviour.

Uses the EqA instance to do an equality check on the bound value.

Uses the OrdDefault instance to do an ordering comparison on the bound value. To use anything other than the default call this.Compare〈OrdA〉(this, other), where OrdA is an instance derived from Ord〈A〉

Uses the Ord instance provided to do an ordering comparison on the bound value.

DO NOT USE - Use the Structural equality variant of this method Equals〈EQ, A〉(y)

Calculate the hash-code from the bound value, unless the Option is in a None state, in which case the hash-code will be 0

Get a string representation of the Option

Impure iteration of the bound value in the structure

Projection from one value to another

Projection from one value to another

Map each element of a structure to an action, evaluate these actions from left to right, and collect the results.

Map each element of a structure to an action, evaluate these actions from left to right, and collect the results.

Monad bind operation

Monad bind operation

Bi-bind. Allows mapping of both monad states

Monad bind operation

Monad bind operation

Match operation with an untyped value for Some. This can be useful for serialisation and dealing with the IOptional interface

Get the Type of the bound value

If the Option is in a Some state then the span will contain one itemm otherwise empty.

Convert the Option to an enumerable of zero or one items

Convert the Option to an immutable list of zero or one items

Convert the Option to an enumerable sequence of zero or one items

Convert the Option to an enumerable of zero or one items

Convert the Option to an enumerable of zero or one items

Convert the structure to an Eff

Convert to an Option transformer with embedded IO

Convert the structure to an Eff

Convert the structure to a Fin

Convert the structure to a Fin

Convert the structure to an Either

Convert the structure to an Either

Convert the structure to an Either

Convert the structure to a Validation

Convert the structure to a Validation

Convert the structure to a Validation

Fluent pattern matching. Provide a Some handler and then follow on fluently with .None(...) to complete the matching operation. This is for dispatching actions, use Some〈A, B〉(...) to return a value from the match operation.

Fluent pattern matching. Provide a Some handler and then follow on fluently with .None(...) to complete the matching operation. This is for returning a value from the match operation, to dispatch an action instead, use Some〈A〉(...)

Match the two states of the Option and return a non-null R.

Match the two states of the Option and return a non-null R.

Match the two states of the Option

Invokes the action if Option is in the Some state, otherwise nothing happens.

Invokes the f function if Option is in the Some state, otherwise nothing happens.

Returns the result of invoking the None() operation if the optional is in a None state, otherwise the bound Some(x) value is returned.

Will not accept a null return value from the None operation

Invokes the action if Option is in the None state, otherwise nothing happens.

Returns the noneValue if the optional is in a None state, otherwise the bound Some(x) value is returned.

Will not accept a null noneValue

Option types are like lists of 0 or 1 items, and therefore follow the same rules when folding.

In the case of lists, 'Fold', when applied to a binary operator, a starting value(typically the left-identity of the operator), and a list, reduces the list using the binary operator, from left to right:

Note that, since the head of the resulting expression is produced by an application of the operator to the first element of the list, 'Fold' can produce a terminating expression from an infinite list.

Option types are like lists of 0 or 1 items, and therefore follow the same rules when folding.

In the case of lists, 'Fold', when applied to a binary operator, a starting value(typically the left-identity of the operator), and a list, reduces the list using the binary operator, from left to right:

Note that, since the head of the resulting expression is produced by an application of the operator to the first element of the list, 'Fold' can produce a terminating expression from an infinite list.

Option types are like lists of 0 or 1 items, and therefore follow the same rules when folding.

In the case of lists, 'Fold', when applied to a binary operator, a starting value(typically the left-identity of the operator), and a list, reduces the list using the binary operator, from left to right:

Note that, since the head of the resulting expression is produced by an application of the operator to the first element of the list, 'Fold' can produce a terminating expression from an infinite list.

Option types are like lists of 0 or 1 items, and therefore follow the same rules when folding.

In the case of lists, 'Fold', when applied to a binary operator, a starting value(typically the left-identity of the operator), and a list, reduces the list using the binary operator, from left to right:

Note that, since the head of the resulting expression is produced by an application of the operator to the first element of the list, 'Fold' can produce a terminating expression from an infinite list.

Projection from one value to another

Projection from one value to another

Return the number of bound values in this structure:

None = 0

Some = 1

Apply a predicate to the bound value. If the Option is in a None state then True is returned (because the predicate applies for-all values). If the Option is in a Some state the value is the result of running applying the bound value to the predicate supplied.

Apply a predicate to the bound value. If the Option is in a None state then True is returned if invoking None returns True. If the Option is in a Some state the value is the result of running applying the bound value to the Some predicate supplied.

Apply a predicate to the bound value. If the Option is in a None state then True is returned if invoking None returns True. If the Option is in a Some state the value is the result of running applying the bound value to the Some predicate supplied.

Apply a predicate to the bound value. If the Option is in a None state then False is returned. If the Option is in a Some state the value is the result of running applying the bound value to the predicate supplied.

Apply a predicate to the bound value. If the Option is in a None state then True is returned if invoking None returns True. If the Option is in a Some state the value is the result of running applying the bound value to the Some predicate supplied.

Apply a predicate to the bound value. If the Option is in a None state then True is returned if invoking None returns True. If the Option is in a Some state the value is the result of running applying the bound value to the Some predicate supplied.

Invoke an action for the bound value (if in a Some state)

Invoke an action depending on the state of the Option

Invoke an action depending on the state of the Option

Apply a predicate to the bound value (if in a Some state)

Apply a predicate to the bound value (if in a Some state)

Partial application map

Partial application map

Monadic bind

Monadic bind

Monadic bind and project

Semigroup combine

Must exist here to make operator true work

Comparison operator

Comparison operator

Comparison operator

Comparison operator

Equality operator

This uses the EqDefault instance for comparison of the bound A values. The EqDefault instance wraps up the .NET EqualityComparer.Default behaviour. For more control over equality you can call:

equals〈EQ, A〉(lhs, rhs);

Where EQ is a struct derived from Eq〈A〉. For example:

equals〈EqString, string〉(lhs, rhs);
equals〈EqArray〈int〉, int[]〉(lhs, rhs);

Non-equality operator

This uses the EqDefault instance for comparison of the A value. The EqDefault trait wraps up the .NET EqualityComparer.Default behaviour. For more control over equality you can call:

!equals〈EQ, A〉(lhs, rhs);

Where EQ is a struct derived from Eq〈A〉. For example:

!equals〈EqString, string〉(lhs, rhs);
!equals〈EqArray〈int〉, int[]〉(lhs, rhs);

Truth operator

Falsity operator

None

Construct an Option of A in a Some state