Struct Event

pub struct Event<'a, P> { /* private fields */ }

A captured record of something significant that occurred during the operation of a system.

Implementations

impl<'a, P> Event<'a, P>

pub fn new( mdl: impl Into<Path<'a>>, tpl: impl Into<Template<'a>>, extent: impl ToExtent, props: P, ) -> Self

Construct an event from its parts.

Events are composed of:

• mdl: A Path to the module that produced the event. This will typically be mdl!() or pkg!().
• tpl: The Template of the event. This is the user-facing description of the event that can be rendered into a readable form.
• extent: The Extent of the event. This is the point in time at which it occurred, or the timespan for which it was active.
• props: The Props attached to the event, captured from the surrounding environment.

pub fn mdl(&self) -> &Path<'a>

Get a reference to the module that produced the event.

pub fn with_mdl(self, mdl: impl Into<Path<'a>>) -> Self

Set the module of the event, returning a new one.

pub fn extent(&self) -> Option<&Extent>

Get a reference to the extent of the event, if there is one.

An event won’t have an extent if it was never constructed with one. This can happen in environments without access to a realtime clock.

pub fn with_extent(self, extent: impl ToExtent) -> Self

Set the extent of the event, returning a new one.

pub fn ts(&self) -> Option<&Timestamp>

Get the extent of the event as a point in time.

If the event has an extent then this method will return Some, with the result of Extent::as_point. If the event doesn’t have an extent then this method will return None.

pub fn ts_start(&self) -> Option<&Timestamp>

Get the start point of the extent of the event.

If the event has an extent, and that extent covers a timespan then this method will return Some. Otherwise this method will return None.

pub fn tpl(&self) -> &Template<'a>

Get a reference to the template of the event.

pub fn with_tpl(self, tpl: impl Into<Template<'a>>) -> Self

Set the template of the event, returning a new one.

pub fn props(&self) -> &P

Get a reference to the properties of the event.

pub fn with_props<U>(self, props: U) -> Event<'a, U>

Set the properties of the event, returning a new one.

pub fn map_props<U>(self, map: impl FnOnce(P) -> U) -> Event<'a, U>

Map the properties of the event, returning a new one.

impl<'a, P: Props> Event<'a, P>

pub fn msg(&self) -> Render<'_, &P>

Get a lazily-evaluated formatting of the event’s template.

pub fn by_ref<'b>(&'b self) -> Event<'b, &'b P>

Get a new event, borrowing data from this one.

pub fn erase<'b>(&'b self) -> Event<'b, &'b dyn ErasedProps>

Get a type-erased event, borrowing data from this one.

Trait Implementations

impl<'a, P: Clone> Clone for Event<'a, P>

fn clone(&self) -> Event<'a, P>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, P: Props> Debug for Event<'a, P>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, P: Props> ToEvent for Event<'a, P>

type Props<'b> = &'b P where Self: 'b

The kind of Props on the resulting value.

fn to_event<'b>(&'b self) -> Event<'b, Self::Props<'b>>

Perform the conversion.