ribelo.fatum

Liking cljdoc? Tell your friends :D

Mostly clj/s.
Exceptions indicated.

->^clj/smacro

(-> expr & more)

like clojure.core/-> but expr is wrapped in attempt, and the following functions in then

like `clojure.core/->` but `expr` is wrapped in [[attempt]], and the following functions in [[then]]

source raw docstring

->>^clj/smacro

(->> expr & more)

like clojure.core/->> but expr is wrapped in attempt, and the following functions in then

like `clojure.core/->>` but `expr` is wrapped in [[attempt]], and the following
functions in [[then]]

source raw docstring

-if-clj^clj/smacro

(-if-clj then & [else])

source

-match-map?^clj/s

(-match-map? x m)

chech if x has every kv from m

chech if `x` has every `kv` from `m`

source raw docstring

and^clj/smacro

(and)

(and x)

(and x & next)

source

attempt^clj/smacro

(attempt & body)

like catching, but takes body as argument

(attempt (/ 1 1))
=> 1

(attempt (/ 1 0))
=>
#error {
:cause "Divide by zero"
:data {}
:via
[{:type ribelo.fatum.Fail
 :message "Divide by zero"
 :data {}}]
:trace
[]}

like [[catching]], but takes `body` as argument

```clojure
(attempt (/ 1 1))
=> 1
```

```clojure
(attempt (/ 1 0))
=>
#error {
:cause "Divide by zero"
:data {}
:via
[{:type ribelo.fatum.Fail
 :message "Divide by zero"
 :data {}}]
:trace
[]}
```

source raw docstring

call^clj/s

(call x f)

attempt to call function f on value x

(call 1 inc)
=> 2

(call "1" inc)
=>
#error {
:cause "class java.lang.String cannot be cast to class java.lang.Number ..."
:data {}
:via
[{:type ribelo.fatum.Fail
 :message "class java.lang.String cannot be cast to class java.lang.Number ... "
 :data {}}]
:trace
[]}

[[attempt]] to call function `f` on value `x`

```clojure
(call 1 inc)
=> 2
```

```clojure
(call "1" inc)
=>
#error {
:cause "class java.lang.String cannot be cast to class java.lang.Number ..."
:data {}
:via
[{:type ribelo.fatum.Fail
 :message "class java.lang.String cannot be cast to class java.lang.Number ... "
 :data {}}]
:trace
[]}
````

source raw docstring

catch^clj/s

(catch x f)

attempt to call function f on value x if x is fail?

(-> {:name "Ivan" :age 17}
    (then-if (comp (partial <= 18) :age) #(assoc % :adult true))
    (then-if (comp (partial > 18) :age) #(assoc % :adult false))
    (fail-if (complement (comp :adult)) "user is underage" #(find % :age))
    (catch-if (constantly :err)))
=> :err

[[attempt]] to call function `f` on value `x` if `x` is [[fail?]]

```clojure
(-> {:name "Ivan" :age 17}
    (then-if (comp (partial <= 18) :age) #(assoc % :adult true))
    (then-if (comp (partial > 18) :age) #(assoc % :adult false))
    (fail-if (complement (comp :adult)) "user is underage" #(find % :age))
    (catch-if (constantly :err)))
=> :err
```

source raw docstring

catch-errors^clj/smacro

(catch-errors & body)

like catching, but returns a vector where the first element is the result of executing the body and the second is an Exception

(catch-errors (/ 1 1)) => [1 nil]

(catch-errors (/ 1 0)) => [nil java.lang.ArithmeticException]

like [[catching]], but returns a vector where the first element is the result of
executing the `body` and the second is an `Exception`

```clojure
(catch-errors (/ 1 1)) => [1 nil]
```
```clojure
(catch-errors (/ 1 0)) => [nil java.lang.ArithmeticException]
```

source raw docstring

catch-if^clj/s

(catch-if x pred f)

attempt to call function f on value x if x is fail?, not reduced and meets isa? condition

(-> {:name "Ivan" :age 17}
    (then-if (comp (partial <= 18) :age) #(assoc % :adult true))
    (then-if (comp (partial > 18) :age) #(assoc % :adult false))
    (fail-if (complement (comp :adult)) "user is underage" #(find % :age))
    (catch-if (comp (partial > 18) :age) (constantly :err)))
=> :err

[[attempt]] to call function `f` on value `x` if `x` is [[fail?]], not
`reduced` and meets [[isa?]] condition

```clojure
(-> {:name "Ivan" :age 17}
    (then-if (comp (partial <= 18) :age) #(assoc % :adult true))
    (then-if (comp (partial > 18) :age) #(assoc % :adult false))
    (fail-if (complement (comp :adult)) "user is underage" #(find % :age))
    (catch-if (comp (partial > 18) :age) (constantly :err)))
=> :err
```

source raw docstring

catching^clj/smacro

(catching expr)

(catching expr err catch)

(catching expr err catch finally)

try to execute expr, if catch an error returns it itself

(catching (/ 1 0) => nil

(catching (/ 1 0) e e) => java.lang.ArithmeticException

`try` to execute `expr`, if `catch` an error returns it itself

```clojure
(catching (/ 1 0) => nil
```
```clojure
(catching (/ 1 0) e e) => java.lang.ArithmeticException
```

source raw docstring

ensure-fail^clj/s

(ensure-fail x)

ensure that Exception err is Fail

ensure that `Exception` `err` is [[Fail]]

source raw docstring

every?^clj/s

(every? pred xs)

source

exception-info?^clj/s

(exception-info? x)

check if x is ExceptionInfo

check if `x` is `ExceptionInfo`

source raw docstring

Fail^cljs

(Fail msg data)

source

fail^clj/s

(fail)

(fail msg)

(fail msg data)

(fail msg k v & kvs)

returns Fail

for flexibility, the data can be either a map, an explicit kv collection or a variadic kv collection

returns [[Fail]]

for flexibility, the `data` can be either a map, an explicit kv collection or
a variadic kv collection

source raw docstring

fail!^clj/s

(fail!)

(fail! msg)

(fail! msg data)

(fail! msg k v & kvs)

throw Fail

see fail

throw [[Fail]]

see [[fail]]

source raw docstring

fail-if^clj/s

(fail-if x pred)

(fail-if x pred msg)

(fail-if x pred msg data-or-fn)

return fail with optional msg and data if x is ok? and meets isa? condition

(-> {:name "Ivan" :age 17}
    (then-if (comp (partial <= 18) :age) #(assoc % :adult true))
    (then-if (comp (partial > 18) :age) #(assoc % :adult false))
    (fail-if (complement (comp :adult)) "user is underage" (juxt (constantly :user) identity)))
=>
#error {
:cause "user is underage"
:data {:user {:name "Ivan", :age 17, :adult false}}
:via
[{:type ribelo.fatum.Fail
 :message "user is underage"
 :data {:user {:name "Ivan", :age 17, :adult false}}}]
:trace
[]}

return [[fail]] with optional `msg` and `data` if `x` is [[ok?]] and
meets [[isa?]] condition

```clojure
(-> {:name "Ivan" :age 17}
    (then-if (comp (partial <= 18) :age) #(assoc % :adult true))
    (then-if (comp (partial > 18) :age) #(assoc % :adult false))
    (fail-if (complement (comp :adult)) "user is underage" (juxt (constantly :user) identity)))
=>
#error {
:cause "user is underage"
:data {:user {:name "Ivan", :age 17, :adult false}}
:via
[{:type ribelo.fatum.Fail
 :message "user is underage"
 :data {:user {:name "Ivan", :age 17, :adult false}}}]
:trace
[]}
```

source raw docstring

fail?^clj/s

(fail? x)

(fail? x & more)

check if x is instance of Exception in clj or js/Error in cljs

check if `x` is instance of `Exception` in clj or `js/Error` in cljs

source raw docstring

fail?!^clj/s

(fail?! x)

(fail?! x & more)

throw x if x meets fail? else returns x

`throw` `x` if `x` meets [[fail?]] else returns x

source raw docstring

finally^clj/s

(finally x f)

attempt to call function f on unreduced value of x. return x unchanged and unreduced.

[[attempt]] to call function `f` on `unreduced` value of `x`. return `x`
unchanged and `unreduced`.

source raw docstring

if-ok^clj/smacro

(if-ok test-or-bindings then)

(if-ok test-or-bindings then else)

Like core/if-let but can bind multiple values. execute then if all tests are ok?

(if-ok (/ 1 1) :ok :err)
=> :ok

(if-ok (/ 1 1) :ok :err)
=> :err

(if-ok nil :ok :err)
=> :ok

Like `core/if-let` but can bind multiple values. execute `then` if all tests
are `ok?`

```clojure
(if-ok (/ 1 1) :ok :err)
=> :ok
```

```clojure
(if-ok (/ 1 1) :ok :err)
=> :err
```

```clojure
(if-ok nil :ok :err)
=> :ok
```

source raw docstring

isa?^clj/s

(isa? x pred)

check if x meets pred, or whether Exception has in ex-data under the key k the value v

(isa? 1 number?) => true

(isa? java.lang.ArithmeticException (catching (/ 1 0))) => true

(isa? {:a 1 :b 2} {:a 1}) => true

(isa? {:a 1 :b 2} {:c 3}) => false

check if `x` meets `pred`, or whether `Exception` has in `ex-data` under the
key `k` the value `v`

```clojure
(isa? 1 number?) => true
```
```clojure
(isa? java.lang.ArithmeticException (catching (/ 1 0))) => true
```
```clojure
(isa? {:a 1 :b 2} {:a 1}) => true
```
```clojure
(isa? {:a 1 :b 2} {:c 3}) => false
```

source raw docstring

ok?^clj/s

(ok? x)

(ok? x & more)

check if x is not Fail

check if `x` is not [[Fail]]

source raw docstring

ok?!^clj/s

(ok?! x)

(ok?! x & more)

throw x if x meets fail? else returns x

`throw` `x` if `x` meets [[fail?]] else returns x

source raw docstring

or^clj/smacro

(or)

(or x)

(or x & next)

source

some^clj/s

(some pred xs)

source

then^clj/s

(then x f)

attempt to call function f on value x if x is ok? and is not reduced

(-> {:name "Ivan" :age 17}
    (then #(update % :age inc)))
=> {:name "Ivan", :age 18}

[[attempt]] to call function `f` on value `x` if `x` is [[ok?]] and is not
`reduced`

```clojure
(-> {:name "Ivan" :age 17}
    (then #(update % :age inc)))
=> {:name "Ivan", :age 18}
```

source raw docstring

then-if^clj/s

(then-if x pred f)

attempt to call function f on value x if x is ok?, not reduced and meets isa? condition

(-> {:name "Ivan" :age 17}
    (then-if (comp (partial <= 18) :age) #(assoc % :adult true))
    (then-if (comp (partial > 18) :age) #(assoc % :adult false)))
 => {:name "Ivan", :age 17, :adult false}

[[attempt]] to call function `f` on value `x` if `x` is [[ok?]], not `reduced`
and meets [[isa?]] condition

```clojure
(-> {:name "Ivan" :age 17}
    (then-if (comp (partial <= 18) :age) #(assoc % :adult true))
    (then-if (comp (partial > 18) :age) #(assoc % :adult false)))
 => {:name "Ivan", :age 17, :adult false}
```

source raw docstring

throw-if^clj/s

(throw-if x pred)

(throw-if x pred msg-or-fn)

(throw-if x pred msg data)

throw fail! with optional msg and data if x is ok? and meets isa? condition

see fail-if

throw [[fail!]] with optional `msg` and `data` if `x` is [[ok?]] and
meets [[isa?]] condition

see [[fail-if]]

source raw docstring

thru^clj/s

(thru x f)

attempt to call function f on unreduced value of x. return x unchanged. used for side effects

[[attempt]] to call function `f` on `unreduced` value of `x`. return `x`
unchanged. used for side effects

source raw docstring

thru-if^clj/s

(thru-if x pred f)

attempt to call function f on unreduced value of x if unreduced x meets isa? condition. return x unchanged. used for side effects

[[attempt]] to call function `f` on `unreduced` value of `x` if `unreduced` `x`
meets [[isa?]] condition. return `x` unchanged. used for side effects

source raw docstring

when-ok^clj/smacro

(when-ok test-or-bindings & body)

Like clojure.core/when however if first arg is binding vector behave like clojure.core/when-let, but can bind multiple values. check if all tests/bindings are ok?, else return Fail with attached var & failing expresions

(when-ok (/ 1 1) :ok)
=> :ok

=> :ok

(when-ok (/ 1 0) :ok
=>
#error {
:cause "Divide by zero"
:data {:binding test, :expr (/ 1 0)}
:via
[{:type ribelo.fatum.Fail
 :message "Divide by zero"
 :data {:binding test, :expr (/ 1 0)}}]
:trace
[]}

(when-ok [x (/ 1 0)] :ok)
=>
#error {
:cause "Divide by zero"
:data {:binding x, :expr (/ 1 0)}
:via
[{:type ribelo.fatum.Fail
 :message "Divide by zero"
 :data {:binding x, :expr (/ 1 0)}}]
:trace
[]}

Like `clojure.core/when` however if first arg is binding vector behave like
`clojure.core/when-let`, but can bind multiple values. check if all
tests/bindings are [[ok?]], else return [[Fail]] with attached var & failing
expresions

```clojure
(when-ok (/ 1 1) :ok)
=> :ok
```

```clojure(when-ok nil :ok)
=> :ok
```

```clojure
(when-ok (/ 1 0) :ok
=>
#error {
:cause "Divide by zero"
:data {:binding test, :expr (/ 1 0)}
:via
[{:type ribelo.fatum.Fail
 :message "Divide by zero"
 :data {:binding test, :expr (/ 1 0)}}]
:trace
[]}
```

```clojure
(when-ok [x (/ 1 0)] :ok)
=>
#error {
:cause "Divide by zero"
:data {:binding x, :expr (/ 1 0)}
:via
[{:type ribelo.fatum.Fail
 :message "Divide by zero"
 :data {:binding x, :expr (/ 1 0)}}]
:trace
[]}
```

source raw docstring

when-ok!^clj/smacro

(when-ok! test-or-bindings & body)

Like clojure.core/when however if first arg is binding vector behave like clojure.core/when-let, but can bind multiple values. check if all tests/bindings are ok?, else throw Fail with attached var & failing expresions

(when-ok (/ 1 1) :ok)
=> :ok

=> :ok

(when-ok (/ 1 0) :ok
=>
#error {
:cause "Divide by zero"
:data {:binding test, :expr (/ 1 0)}
:via
[{:type ribelo.fatum.Fail
 :message "Divide by zero"
 :data {:binding test, :expr (/ 1 0)}}]
:trace
[]}

(when-ok [x (/ 1 0)] :ok)
=>
#error {
:cause "Divide by zero"
:data {:binding x, :expr (/ 1 0)}
:via
[{:type ribelo.fatum.Fail
 :message "Divide by zero"
 :data {:binding x, :expr (/ 1 0)}}]
:trace
[]}

Like `clojure.core/when` however if first arg is binding vector behave like
`clojure.core/when-let`, but can bind multiple values. check if all
tests/bindings are [[ok?]], else throw [[Fail]] with attached var & failing
expresions

```clojure
(when-ok (/ 1 1) :ok)
=> :ok
```

```clojure(when-ok nil :ok)
=> :ok
```

```clojure
(when-ok (/ 1 0) :ok
=>
#error {
:cause "Divide by zero"
:data {:binding test, :expr (/ 1 0)}
:via
[{:type ribelo.fatum.Fail
 :message "Divide by zero"
 :data {:binding test, :expr (/ 1 0)}}]
:trace
[]}
```

```clojure
(when-ok [x (/ 1 0)] :ok)
=>
#error {
:cause "Divide by zero"
:data {:binding x, :expr (/ 1 0)}
:via
[{:type ribelo.fatum.Fail
 :message "Divide by zero"
 :data {:binding x, :expr (/ 1 0)}}]
:trace
[]}
```

source raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcuts Report a problem cljdoc on GitHub

× close

ribelo.fatum

->clj/smacro

->>clj/smacro

-if-cljclj/smacro

-match-map?clj/s

andclj/smacro

attemptclj/smacro

callclj/s

catchclj/s

catch-errorsclj/smacro

catch-ifclj/s

catchingclj/smacro

ensure-failclj/s

every?clj/s

exception-info?clj/s

Failcljs

failclj/s

fail!clj/s

fail-ifclj/s

fail?clj/s

fail?!clj/s

finallyclj/s

if-okclj/smacro

isa?clj/s

ok?clj/s

ok?!clj/s

orclj/smacro

someclj/s

thenclj/s

then-ifclj/s

throw-ifclj/s

thruclj/s

thru-ifclj/s

when-okclj/smacro

when-ok!clj/smacro

->^clj/smacro

->>^clj/smacro

-if-clj^clj/smacro

-match-map?^clj/s

and^clj/smacro

attempt^clj/smacro

call^clj/s

catch^clj/s

catch-errors^clj/smacro

catch-if^clj/s

catching^clj/smacro

ensure-fail^clj/s

every?^clj/s

exception-info?^clj/s

Fail^cljs

fail^clj/s

fail!^clj/s

fail-if^clj/s

fail?^clj/s

fail?!^clj/s

finally^clj/s

if-ok^clj/smacro

isa?^clj/s

ok?^clj/s

ok?!^clj/s

or^clj/smacro

some^clj/s

then^clj/s

then-if^clj/s

throw-if^clj/s

thru^clj/s

thru-if^clj/s

when-ok^clj/smacro

when-ok!^clj/smacro