monex v0.1.6 MonEx.Result
Result module provides Result type with utility functions.
Summary
Functions
Filters collection of results, leaving only errors:
[ok(1), error("oops")] |> collect_error == [error("oops")]
Filters collection of results, leaving only ok’s
[ok(1), error("oops")] |> collect_ok == [ok(1)]
Returns monad if it is ok()
, or evaluates supplied lambda that expected
to return another result
. Returns supplied fallback value, if it’s not a function.
ok(5) |> fallback(fn _ -> 1 end) == ok(5)
error("WTF") |> fallback(fn m -> ok("#{m}LOL") end) == ok("WTFLOL")
error("WTF") |> fallback(ok(5)) == ok(5)
Returns true if argument is error()
, false if ok()
is_error(error("Error")) == true
Returns true if argument is ok()
, false if error()
is_ok(ok(5)) == true
Returns value x
if argument is ok(x)
, raises e
if error(e)
5 == unwrap(ok(5))
Types
Functions
Filters collection of results, leaving only errors:
[ok(1), error("oops")] |> collect_error == [error("oops")]
Filters collection of results, leaving only ok’s
[ok(1), error("oops")] |> collect_ok == [ok(1)]
Returns monad if it is ok()
, or evaluates supplied lambda that expected
to return another result
. Returns supplied fallback value, if it’s not a function.
ok(5) |> fallback(fn _ -> 1 end) == ok(5)
error("WTF") |> fallback(fn m -> ok("#{m}LOL") end) == ok("WTFLOL")
error("WTF") |> fallback(ok(5)) == ok(5)
Returns true if argument is error()
, false if ok()
is_error(error("Error")) == true
Returns true if argument is ok()
, false if error()
is_ok(ok(5)) == true
Returns value x
if argument is ok(x)
, raises e
if error(e)
5 == unwrap(ok(5))