either_or - v1.0.0

either_or

Types

EitherOr

</>

A generic choice type.

pub type EitherOr(a, b) {
  Either(a)
  Or(b)
}

Constructors 

  • Either(a)
  • Or(b)

Values

classify

</> 
pub fn classify(
  a: a,
  classifier classifier: fn(a) -> Bool,
) -> EitherOr(a, a)

Given a value z of type z and a function fn(z) -> Bool constructs a value of type EitherOr(z, z) by outputting Either(z) if f(z) is True, else Or(z).

discriminate

</> 
pub const discriminate: fn(List(a), fn(a) -> Bool) -> List(
  EitherOr(a, a),
)

Alias for map_classify.

flat_map_either

</> 
pub fn flat_map_either(
  v: EitherOr(a, b),
  f: fn(a) -> EitherOr(c, b),
) -> EitherOr(c, b)

Compose map_either and flatten.

flat_map_eo

</> 
pub fn flat_map_eo(
  v: EitherOr(a, b),
  f1: fn(a) -> EitherOr(c, d),
  f2: fn(b) -> EitherOr(c, d),
) -> EitherOr(c, d)

Apply a map of codomain EitherOr(c, d) to either side of an EitherOr(a, b) and flatten

Symmetric to flat_map_eo.

Both functions are offered to in order to allow the happy path to be pursued with either ‘Either’ or ‘Or’ variants via the use <- syntax.

flat_map_oe

</> 
pub fn flat_map_oe(
  v: EitherOr(a, b),
  f2: fn(b) -> EitherOr(c, d),
  f1: fn(a) -> EitherOr(c, d),
) -> EitherOr(c, d)

Aplly a map of codomain EitherOr(c, d) to either side of an EitherOr(a, b) and flatten

Symmetric to flat_map_eo.

Both functions are offered to in order to allow the happy path to be pursued with either ‘Either’ or ‘Or’ variants via the use <- syntax.

flat_map_or

</> 
pub fn flat_map_or(
  v: EitherOr(a, b),
  with f: fn(b) -> EitherOr(a, c),
) -> EitherOr(a, c)

Compose map_or and flatten.

flatten

</> 
pub fn flatten(
  either: EitherOr(EitherOr(a, b), EitherOr(a, b)),
) -> EitherOr(a, b)

Flatten a EitherOr(EitherOr(a, b), EitherOr(a, b)) value.

flatten_either

</> 
pub fn flatten_either(
  either: EitherOr(EitherOr(a, b), b),
) -> EitherOr(a, b)

Flatten a EitherOr(EitherOr(a, b), b) value.

flatten_or

</> 
pub fn flatten_or(
  either: EitherOr(a, EitherOr(a, b)),
) -> EitherOr(a, b)

Flatten a EitherOr(a, EitherOr(a, b)) value.

from_bool

</> 
pub fn from_bool(z: z, b: Bool) -> EitherOr(z, z)

Given a value z of arbitrary type and a bool b constructs a value of type EitherOr(z, z) by outputting Either(z) if b is True, else Or(z).

from_result

</> 
pub fn from_result(z: Result(a, b)) -> EitherOr(a, b)

Converts a Result(a, b) into an EitherOr(a, b).

get_either

</> 
pub fn get_either(v: EitherOr(a, b)) -> option.Option(a)

Converts an EitherOr(a, b) value into Some(x) if the value has the form Either(x), else None.

get_or

</> 
pub fn get_or(v: EitherOr(a, b)) -> option.Option(b)

Converts an EitherOr(a, b) value into Some(x) if the value has the form Or(x), else None.

group_eithers

</> 
pub fn group_eithers(
  ze_list: List(EitherOr(a, b)),
) -> List(EitherOr(List(a), b))

Aggregates the payloads of consecutive Either instances from a List(EitherOr(a, b)) into single Either(List(a)) elements, such as to turn a List(EitherOr(a, b)) into a List(EitherOr(List(a), b)). Introduces an element of the form Either([]: List(a)) between each consecutive pair of ‘Or(b)’ elements symoblizing an empty of ‘Either’ payloads sitting between pair of consecutive ‘Or(b)’ elements.

group_eithers_no_empty_lists

</> 
pub fn group_eithers_no_empty_lists(
  ze_list: List(EitherOr(a, b)),
) -> List(EitherOr(List(a), b))

Aggregates the payloads of consecutive Either instances from a List(EitherOr(a, b)) into single Either(List(a)) elements, such as to turn a List(EitherOr(a, b)) into a List(EitherOr(List(a), b)). Discards elements of the form Either([]) from the final list.

group_ors

</> 
pub fn group_ors(
  ze_list: List(EitherOr(a, b)),
) -> List(EitherOr(a, List(b)))

Aggregates the payloads of consecutive Or instances from a List(EitherOr(a, b)) into single Or(List(b)) elements, such as to turn a List(EitherOr(a, b)) into a List(EitherOr(a, List(b))). Introduces an element of the form Or([]: List(a)) between each consecutive pair of ‘Either(a)’ elements, symoblizing an empty of ‘Or’ payloads sitting between pair of consecutive ‘Either(a)’ elements.

group_ors_no_empty_lists

</> 
pub fn group_ors_no_empty_lists(
  ze_list: List(EitherOr(a, b)),
) -> List(EitherOr(a, List(b)))

Aggregates the payloads of consecutive Either instances from a List(EitherOr(a, b)) into single Either(List(a)) elements, such as to turn a List(EitherOr(a, b)) into a List(EitherOr(List(a), b)). Discards elements of the form Or([]) from the final list.

is_either

</> 
pub fn is_either(v: EitherOr(a, b)) -> Bool

Given an EitherOr value returns True if and only if the value is an Either variant.

is_or

</> 
pub fn is_or(v: EitherOr(a, b)) -> Bool

Given an EitherOr value returns True if and only if the value is an Or variant.

map_classify

</> 
pub fn map_classify(
  list: List(z),
  classifier classifier: fn(z) -> Bool,
) -> List(EitherOr(z, z))

Given a List(z) of arbitrary type and a function f: fn(z) -> Bool, returns a List(EitherOr(z, z)) by mapping over the list with classify(_, f), i.e., by replacing each value z of the list with Either(z) if f(z) True, Or(z) otherwise.

map_either

</> 
pub fn map_either(
  v: EitherOr(a, b),
  f: fn(a) -> c,
) -> EitherOr(c, b)

Given a value of type EitherOr(a, b) and a function f(a) -> c returns Either(f(a)) if the value has the form Either(a) and returns Or(b) if the value has the form Or(b).

map_eithers

</> 
pub fn map_eithers(
  v: List(EitherOr(a, b)),
  f: fn(a) -> c,
) -> List(EitherOr(c, b))

Given a List(EitherOr(a, b)) and a function f: fn(a) -> c returns a List(EitherOr(c, b)) by applying map_either(_, f) to each element of the list.

map_eo

</> 
pub fn map_eo(
  v: EitherOr(a, b),
  on_either: fn(a) -> a_prime,
  on_or: fn(b) -> b_prime,
) -> EitherOr(a_prime, b_prime)

Apply separate maps to each payload of an EitherOr value.

Symmetric to map_eo.

Both functions are offered to in order to allow the happy path to be pursued with either ‘Either’ or ‘Or’ variants via the use <- syntax.

map_oe

</> 
pub fn map_oe(
  v: EitherOr(a, b),
  on_or: fn(b) -> b_prime,
  on_either: fn(a) -> a_prime,
) -> EitherOr(a_prime, b_prime)

Apply separate maps to each payload of an EitherOr value.

Symmetric to map_oe.

Both functions are offered to in order to allow the happy path to be pursued with either ‘Either’ or ‘Or’ variants via the use <- syntax.

map_or

</> 
pub fn map_or(
  v: EitherOr(a, b),
  with f: fn(b) -> c,
) -> EitherOr(a, c)

Given a value of type EitherOr(a, b) and a function f(b) -> c returns Or(f(b)) if the value has the form Or(b) and returns Either(a) if the value has the form Either(a).

map_ors

</> 
pub fn map_ors(
  v: List(EitherOr(a, b)),
  f: fn(b) -> c,
) -> List(EitherOr(a, c))

Given a List(EitherOr(a, b)) and a function f: fn(b) -> c returns a List(EitherOr(a, c)) by applying map_or(_, f) to each element of the list.

map_resolve

</> 
pub fn map_resolve(
  v: List(EitherOr(a, b)),
  on_either f: fn(a) -> c,
  on_or g: fn(b) -> c,
) -> List(c)

Given a List(EitherOr(a, b)) and functions f: fn(a) -> c, g: fn(b) -> c, returns a List(c) by mapping each element of the form Either(a) to f(a) and each element of the form Or(b) to g(b).

remove_eithers_unwrap_ors

</> 
pub fn remove_eithers_unwrap_ors(
  ze_list: List(EitherOr(a, b)),
) -> List(b)

Given a List(EitherOr(a, b)), removes all elements of the form Either(a) and unwraps the remaining elements of the form Or(b).

remove_ors_unwrap_eithers

</> 
pub fn remove_ors_unwrap_eithers(
  ze_list: List(EitherOr(a, b)),
) -> List(a)

Given a List(EitherOr(a, b)), removes all elements of the form Or(b) and unwraps the remaining elements of the form Either(a).

resolve_eo

</> 
pub fn resolve_eo(
  t: EitherOr(a, b),
  on_either f1: fn(a) -> c,
  on_or f2: fn(b) -> c,
) -> c

Given a value of type EitherOr(a, b) and functions f1(a) -> c, f2(b) -> c, returns f1(a) if the value has the form Either(a) and returns f2(b) if the value has the form Or(b).

Symmetric to resolve_oe.

Both functions are offered to in order to allow the happy path to be pursued with either ‘Either’ or ‘Or’ variants via the use <- syntax.

resolve_oe

</> 
pub fn resolve_oe(
  t: EitherOr(a, b),
  on_or f1: fn(b) -> c,
  on_either f2: fn(a) -> c,
) -> c

Given a value of type EitherOr(a, b) and functions f1(b) -> c, f1(a) -> c, returns f1(a) if the value has the form Either(a) and returns f2(b) if the value has the form Or(b).

Symmetric to resolve_eo.

Both functions are offered to in order to allow the happy path to be pursued with either ‘Either’ or ‘Or’ variants via the use <- syntax.

swap

</> 
pub fn swap(v: EitherOr(a, b)) -> EitherOr(b, a)

Given a value of type EitherOr(a, b) returns a value of type EitherOr(b, a) by swapping the Either constructor for the Or constructor and vice-versa.

to_result

</> 
pub fn to_result(z: EitherOr(a, b)) -> Result(a, b)

Converts an EitherOr(a, b) into a Result(a, b).

unwrap_either

</> 
pub fn unwrap_either(v: EitherOr(a, b), default: a) -> a

Given an EitherOr value returns x if the value has the form Either(x) otherwise returns the supplied default.

unwrap_or

</> 
pub fn unwrap_or(v: EitherOr(a, b), default: b) -> b

Given an EitherOr value returns x if the value has the form Or(x) otherwise returns the supplied default.

✨ Search Document