pallet.common.context — dda/pallet-common 0.5.0

A hierarchical context, with callbacks on entry and exit of a context. The context is a map, with implementation scopes. Options can be used to modify the behaviour of the context, as a form of middleware.

:on-enter - the return value is merged into the context :on-exit - the return value is ignored

*current-context* clj

Thread specific current context

compose-keys clj

The keys that control the behaviour of a context.

context-entries clj

(context-entries context)

Return the context entries for a context

context-entries-as-string clj

(context-entries-as-string entries)

context-history clj/s macro

(context-history {:keys [history-kw limit] :or {history-kw :history limit 100}})

current-context clj

(current-context)

Return the current context.

formatted-context clj

(formatted-context)

(formatted-context context)

Return the last formatted context entry for a context

formatted-context-entries clj

(formatted-context-entries)

(formatted-context-entries context)

Return the formatted context entries for a context

formatted-history clj

(formatted-history context)

formatted-scope-entries clj

(formatted-scope-entries)

(formatted-scope-entries context scope)

Return the formatted context entries for the given scope

in-context clj/s macro

(in-context entry options & body)

Create a scope by pushing a context entry onto the context. On exit of the body, the context is popped.

Recognised options are: scope on-enter on-exit on-exception format

log-context clj/s macro

(log-context options)

Execute body, logging the current context.

make-context clj

(make-context &
              {:keys [scope on-enter on-exit on-exception format]
               :or {scope :pallet.common.context/default}
               :as options})

Returns a new context. Accepts optional callbacks for :on-enter and on-exit, which are called for every change in context.

on-enter clj

(on-enter context entry)

on-exception clj

(on-exception context exception-map)

on-exit clj

(on-exit context entry)

option-keys clj

The keys that control the behaviour of a context.

options clj

(options context
         {:keys [scope on-enter on-exit on-exception format] :as options})

Set the options for a context. Accepts :on-enter and :on-exit callback functions.

override-defaults clj

override-keys clj

The keys that control the behaviour of a context.

push-entry clj

(push-entry context entry)

scope-context-entries clj

(scope-context-entries scope)

(scope-context-entries context scope)

Return a sequence of context entries for the specified scope

scope-formatted-context-entries clj

(scope-formatted-context-entries scope)

(scope-formatted-context-entries context scope)

Return a sequence of formatted context entries for the specified scope

set-context-scope clj

(set-context-scope context scope)

throw-map clj

(throw-map msg {:as exception-map})

Throws a map, containing the current context on the :context scope

try-context clj/s macro

(try-context options & body)

Execute body, wrapping any exceptions in an exception which includes the current context.

update-context-scope clj

(update-context-scope context scope)

Set the context scope for entries in a context.

with-context clj/s macro

(with-context entry options & body)

Wraps the body with a context, and re-throws wrapped exceptions

with-context-history clj/s macro

(with-context-history {:keys [history-kw limit] :as options} & body)

Add context to a limited history

with-context-logging clj/s macro

(with-context-logging & body)

Log context entries and exits

with-logged-context clj/s macro

(with-logged-context entry options & body)

Wraps the body with a context, and re-throws wrapped exceptions