mirror of
https://github.com/taoensso/telemere.git
synced 2025-12-30 14:48:24 +00:00
ac5feb4723
This change will only affect rare advanced users that depend on the return value of `log!` or `event!`. For all other users this will be a non-breaking change. Before this commit: `log!` and `event!` returned true iff signal was allowed. After this commit: `log!` and `event!` now ALWAYS return nil. `log!?` and `event!?` have been added that keep the old behaviour. Motivation: It's pretty rare to use the return value when generating log or event signals. I originally included the return value since it CAN be handy, and I figured it could just be ignored by those that don't need it. But #53 showed that there's a downside I hadn't anticipated - some users may actually depend on / prefer a nil return to prevent accidentally affecting program flow. I think that's a legitimate enough concern to still make a change now before v1 final. Apologies for the nuissance!
40 lines
1.5 KiB
Text
40 lines
1.5 KiB
Text
ALWAYS (unconditionally) executes given `run` form and:
|
|
|
|
Default kind: `:error`
|
|
Default level: `:error`
|
|
Returns:
|
|
- If given `run` form succeeds: returns the form's result.
|
|
- If given `run` form throws ANYTHING:
|
|
Calls `error!` with the thrown error and given signal options [2], then
|
|
either returns given (:catch-val opts), or rethrows.
|
|
|
|
Just a convenience util. For more flexibility use your own `try/catch`.
|
|
See `taoensso.encore/try*` for easily catching cross-platform errors.
|
|
|
|
Examples:
|
|
|
|
(catch->error! (/ 1 0)) ; %> {:kind :error, :level :error, :error <caught> ...}
|
|
(catch->error! ::my-id (/ 1 0)) ; %> {... :id ::my-id ...}
|
|
(catch->error!
|
|
{:let [x "x"] ; Available to `:data` and `:msg`
|
|
:data {:x x}
|
|
:msg ["My msg:" x]
|
|
:catch-val "Return value iff form throws"}
|
|
|
|
(/ 1 0)) ; %> {... :data {x "x"}, :msg_ "My msg: x" ...}
|
|
|
|
Tips:
|
|
|
|
- Test using `with-signal`: (with-signal (catch->error! ...)).
|
|
- Supports the same options [2] as other signals [1].
|
|
|
|
- Useful for preventing errors from going unnoticed in futures, callbacks,
|
|
agent actions, etc.!: (future (catch->error ::my-future (do-something)))
|
|
|
|
See also `error!`.
|
|
|
|
----------------------------------------------------------------------
|
|
[1] See `help:signal-creators` - (`signal!`, `log!`, `event!`, ...)
|
|
[2] See `help:signal-options` - {:keys [kind level id data ...]}
|
|
[3] See `help:signal-content` - {:keys [kind level id data ...]}
|
|
[4] See `help:signal-filters` - (by ns/kind/id/level, sampling, etc.)
|