This library is intended to be used by tools, such as cli's, which have multiple user interface options, through which they can communicate, while also having various separate commands (or flows) which require each to carefully specify their own output formatting.
The library consists of three primary building blocks, and a default implementation on top of these building blocks.
The three building blocks are:
-
[
crate::EventHandler]: The event handler receives an event (our message type) as input, and decides what to do with this message. Examples include a json-lines handler which prints events to to stderr, a progress bar, a faked handler which collects events for which may be asserted on in software tests, or a handler which sends websocket messages for each event. -
[
crate::Reporter]: Used to communicate messages to a user. -
[
crate::EventListener]: Receives the messages, send by a reporter and runs theEventHandlerwhere appropriate.
On top of these building blocks, a channel based implementation is provided which runs the EventHandler
in a separate thread.
To use this implementation, consult the docs for the [crate::ChannelReporter],
and the [crate::ChannelEventListener].