Given a List(a) and a callback f() -> List(a) returns the list if the is nonempty, else evaluates the callback.

Example 1

use <- on.empty([1, 4, 7])
// -> execution discontinues, scope returns [1, 4, 7]

Example 2

use <- on.empty([])
// -> execution proceeds, the scope must return a List(c)

Given a List(a), a value of type c, and callbacks f(a, a, List(a)) -> c, f(a) -> c, returns:

• the value of type c if the list is empty
• the first callback evaluated with arguments a1, a2, rest if the list has the form [a1, a2, ..rest]
• the second callback evaluated with argument a1 if the list as the form [a1]

Example 1

use first <- on.empty_gt1_singleton(
  [1, 4, 7],
  on_empty: Error("empty list"),
  on_gt1: Error("> 1 element in list"),
)
// -> execution discontinues, scope returns Error("> 1 element in list")

Example 2

use first <- on.empty_gt1_singleton(
  [4],
  on_empty: Error("empty list"),
  on_gt1: Error("> 1 element in list"),
)
// -> execution proceeds, first == 4;
// scope must return a Result(c, String) to match the on_empty 
// and on_gt1 callbacks

Given a List(a), a value of type c, and callback f(a, List(a)) -> c, returns either the value of type c if the list is empty or else applies the callback to the head: a and tail: List(a) of the list.

Example 1

use first, rest <- on.empty_nonempty(
  [1, 4, 7],
  on_empty: "Joe",
)
// -> execution proceeds, first == 1, rest == [4, 7];
// scope must return a String to match the empty list
// return value

Example 2

use first, rest <- on.empty_nonempty(
  [],
  on_empty: "Joe",
)
// -> execution discontinues, scope returns "Joe"

Given a List(a), a value of type c, and callbacks f(a) -> c, f(a, a, List(a)) -> c, returns:

• the value of type c if the list is empty
• the first callback evaluated with argument a1 if the list as the form [a1]
• the second callback evaluated with arguments a1, a2, rest if the list has the form [a1, a2, ..rest]

Example 1

use first, second, ..rest <- on.empty_singleton_gt1(
  [1, 4, 7],
  on_empty: 0,
  on_singleton: fn(first) { first },
)
// -> execution proceeds, first == 1, second == 4, rest == [7];
// scope must return an Int to match the on_empty, on_singleton callbacks

Example 2

use first, second, ..rest <- on.empty_singleton_gt1(
  [4],
  on_empty: 0,
  on_singleton: fn(first) { first },
)
// -> execution discontinues, scope resturns 4

Given a Result(a, b) and a callback f(b) -> Result(a, c) applies the callback if the Result has type Error else maps the Ok variant of type Result(a, b) to the Ok variant of type Result(c, b).

Equivalent to on.ok_error(_, fn(o) -> {Ok(o)}, _).

Example 1

use error_payload <- on.error(Ok(3))
// -> execution discontinues, scope returns Ok(3)

Example 2

use error_payload <- on.error(Error("Joe"))
// -> execution proceeds, error_payload == "Joe";
// the scope must return a Result(a, c)

Given a Result(a, b) and callbacks f(b) -> c, f(a) -> c, returns the evaluation of the first callback at b1 if the Result is Error(b1) and the evaluation of the second callback at a1 if Result is Ok(a1).

Example 1

use ok_payload <- on.error_ok(
  Ok(3),
  on_error: fn(e) { "hi " <> e <> "!" },
)
// -> execution proceeds, ok_payload == 3; the scope must return
// a String to match the return value of the on_error callback

Example 2

use ok_payload <- on.error_ok(
  Error("Joe"),
  on_error: fn(e) { "hi " <> e <> "!" },
)
// -> execution discontinues, scope returns "hi Joe!"

Given a Bool returns True if the bool is True, else returns a lazily evaluated callback.

Example 1

use <- on.false(True)
// -> execution discontinues, scope returns True

Example 2

use <- on.false(False)
// -> execution proceeds, scope must return a Bool

Given a Bool, a value of type c and a callback f() -> c, returns the value of type c if the bool is False, else the evaluation of the callback.

Example 1

use <- on.false_true(
  True,
  on_false: "Joe",
)
// -> execution proceeds, the scope must return a String to 
// match the return value of the on_false argument

Example 2

use <- on.false_true(
  False,
  on_false: "Joe",
)
// -> execution discontinues, scope returns "Joe"

Given a List(a) and callbacks f() -> c, f(a, a, List(a)) -> c, f(a) -> c, returns:

• the evaluation of the first callback if the list is empty
• the second callback evaluated with arguments a1, a2, rest if the list has the form [a1, a2, ..rest]
• the third callback evaluated with argument a1 if the list as the form [a1]

Example 1

use first <- on.lazy_empty_gt1_singleton(
  [1, 4, 7],
  on_empty: Error("empty list"),
  on_gt1: fn(_, _, _) {Error("> 1 element in list")},
)
// -> execution discontinues, scope returns Error("> 1 element in list")

Example 2

use first <- on.lazy_empty_gt1_singleton(
  [4],
  on_empty: Error("empty list"),
  on_gt1: Error("> 1 element in list"),
)
// -> execution proceeds, first == 4;
// scope must return a Result(c, String) to match the on_empty 
// and on_gt1 callbacks

Given a List(a), a callback fn() -> c and a callback f(a, List(a)) -> c, evaluates the first callback if the list is empty else applies the second callback to the head: a and tail: List(a) of the list.

Example 1

use first, rest <- on.lazy_empty_nonempty(
  [1, 4, 7],
  on_empty: fn() { "Joe" },
)
// -> execution proceeds, first == 1, rest == [4, 7];
// scope must return a String to match the empty list
// callback return value

Example 2

use first, rest <- on.lazy_empty_nonempty(
  [],
  on_empty: fn() { "Joe" },
)
// -> execution discontinues, scope returns "Joe"

Given a List(a), and callbacks f() -> c, f(a) -> c, f(a, a, List(a)) -> c, returns:

• the evaluation of the first callback if the list is empty
• the second callback evaluated with argument a1 if the list as the form [a1]
• the third callback evaluated with arguments a1, a2, rest if the list has the form [a1, a2, ..rest]

Example 1

use first, second, ..rest <- on.lazy_empty_singleton_gt1(
  [1, 4, 7],
  on_empty: 0,
  on_singleton: fn(first) { first },
)
// -> execution proceeds, first == 1, second == 4, rest == [7];
// scope must return an Int to match the on_empty, on_singleton callbacks

Example 2

use first, second, ..rest <- on.lazy_empty_singleton_gt1(
  [4],
  on_empty: 0,
  on_singleton: fn(first) { first },
)
// -> execution discontinues, scope resturns 4

Given a Bool and two callbacks f() -> c returns the evaluation of the first callback if the bool is False, else the second callback.

Example 1

use <- on.lazy_false_true(
  True,
  on_false: fn() { "Joe" },
)
// -> execution proceeds, the scope must return a String 
// to match the return value of the on_false argument

Example 2

use <- on.lazy_false_true(
  False,
  on_false: fn() { "Joe" },
)
// -> execution discontinues, scope returns "Joe"

Given an Option(a), a callback f() -> c and a callback f(a) -> c evaluates the first callback if the option is None, else evaluates the second callback on the option’s payload.

Example 1

use payload <- on.lazy_none_some(
  Some(3),
  on_none: fn() { "Bob" },
)
// -> execution proceeds, payload == 3; the scope must return
// a String to match the return value of the on_none return
// value

Example 2

use payload <- on.lazy_none_some(
  None,
  on_none: fn() { "Bob" },
)
// -> execution discontinues, scope returns "Bob"

Given a Bool and two callbacks f() -> c returns the evaluation of the first callback if the bool is True, else the second callback.

Example 1

use <- on.lazy_true_false(
  True,
  on_true: fn() { "Joe" },
)
// -> execution discontinues, scope returns "Joe"

Example 2

use <- on.lazy_true_false(
  False,
  on_true: fn() { "Joe" },
)
// -> execution proceeds, the scope must return a String to 
// match the return value of the on_false argument

Given an Option(a) and a callback f() -> Option(a), applies the callback if the option is None, else returns the option unchanged.

Example 1

use <- on.none(Some(3))
// -> execution discontinues, scope returns Some(3)

Example 2

use <- on.none(None)
// -> execution proceeds, the scope must return an Option(a)

Given an Option(a), a value of type c and a callback f(a) -> c, returns the value of type c if the option is None, else applies the callback to the option’s payload.

Examples

use payload <- on.none_some(
  Some(3),
  on_none: "Bob",
)
// -> execution proceeds, payload == 3; the scope must return a
// String to match the return value of the on_none return value

use payload <- on.none_some(
  None,
  on_none: "Bob",
)
// -> execution discontinues, scope returns "Bob"

Given a List(a) and a callback f(a, List(a)) -> List(c), returns the empty list if the list is empty, else evaluates the callback on (first, rest) where ‘first’ is the first element and ‘tail’ is the tail of the list.

Example 1

use first, rest <- on.nonempty([1, 4, 7])
// -> execution proceeds, first == 1, rest == [1, 7];
// scope must return a List(c)

Example 2

use first, rest <- on.nonempty([])
// -> execution discontinues, scope returns []

Given a List(a), a callback f(a, List(a)) -> c, and a callback f() -> c, returns either the first callback evaluated on the first element and tail of the list if the list is nonempty, and otherwise evaluates the second callback, if the list is empty.

Example 1

use <- on.nonempty_empty(
  [1, 4, 7],
  fn(first, _rest) { first + 1 },
)
// -> execution discontinues, scope returns 2

Example 2

use <- on.nonempty_empty(
  [],
  fn(first, _rest) { first + 1 },
)
// -> execution proceeds, the scope must return an
// integer to match the return value of the first
// callback

Given a Result(a, b) and a callback f(a) -> Result(c, b) applies the callback if the Result has type Ok else maps the Error variant of type Result(a, b) to the Error variant of type Result(c, b).

Equivalent to result.try and to error_ok(_, fn(e) -> {Error(e)}, _).

Example 1

use ok_payload <- on.ok(Ok(3))
// -> execution proceeds, ok_payload == 3; the current scope must
// return a Result(c, b) for some c, b

Example 2

use ok_payload <- on.ok(Error("Joe"))
// -> execution discontinues, scope returns Error("Joe")

Given a Result(a, b) and callbacks f(b) -> c, f(a) -> c, returns the evaluation of the first callback at a1 if the Result is Ok(a1) and the evaluation of the second callback at b1 if Result is Error(b1).

Example 1

use error_payload <- on.ok_error(
  Ok(3),
  on_ok: fn(x) { x + 1 },
)
// -> execution discontinues, scope returns 4

Example 2

use error_payload <- on.ok_error(
  Error("Joe"),
  on_ok: fn(x) { x + 1 },
)
// -> execution proceeds, error_payload == "Joe"; the scope
// must return an Int to match the return value of the on_ok
// callback

Given a List(a) and callbacks f(a) -> c, f(a, a, List(a)) -> c, f() -> c, returns:

• the first callback evaluated with argument a1 if the list as the form [a1]
• the second callback evaluated with arguments a1, a2, rest if the list has the form [a1, a2, ..rest]
• the evaluation of the third callback if the list is empty

Example 1

use <- on.singleton_gt1_empty(
  [1, 4, 7],
  on_singleton: fn(x) { x + 1 },
  on_gt1: fn(first, second, ..rest) { first + second},
)
// -> execution discontinues, scope returns 5 (= 1 + 4)

Example 2

use first, second, ..rest <- on.singleton_gt1_empty(
  [],
  on_singleton: fn(x) { x + 1 },
  on_gt1: fn(first, second, ..rest) { first + second},
)
// -> execution proceeds, scope must return an Int to 
// match the on_singleton, on_gt1 callbacks

Given an Option(a) and a callback f(a) -> Option(c) applies the callback to the payload a if the option is Some(a), else returns None.

Equivalent to:

• on.none_some(_, None, _).
• option.then

Example 1

use payload <- on.some(Some(3))
// -> execution proceeds, payload == 3; the scope must return
// an Option(c)

Example 2

use payload <- on.some(None)
// -> execution discontinues, scope returns None

Given an Option(a), a callback f(a) -> c and a callback f() -> c, evaluates the first callback on the option’s payload, else evaluates the second callback if the option is None.

Example 1

use <- on.some_none(
  Some(3),
  on_some: fn(x) { x + 1 },
)
// -> execution discontinues, scope returns 4

Example 2

use <- on.some_none(
  None,
  on_some: fn(x) { x + 1 },
)
// -> execution proceeds, the scope must return an Int to match
// the return value of the on_some return value

Given a Bool returns False if the bool is False, else returns a lazily evaluated callback.

Equivalent to on.false_true(_, False, _).

Example 1

use <- on.true(True)
// -> execution proceeds, scope must return a Bool

Example 2

use <- on.true(False)
// -> execution discontinues, scope returns False

Given a Bool, a value of type c and a callback f() -> c, returns the value of type c if the bool is True, else the evaluation of the callback.

Example 1

use <- on.true_false(
  True,
  on_true: "Joe",
)
// -> execution discontinues, scope returns "Joe"

Example 2

use <- on.true_false(
  False,
  on_true: "Joe",
)
// -> execution proceeds, the scope must return a String to 
// match the return value of the on_true argument