Struct Event

#[non_exhaustive]
pub struct Event<T: ?Sized> {
    pub at: SystemTime,
    pub value: T,
}

Arbitrary event, optionally paired with additional metadata.

Any metadata is added by enabling the correspondent library feature:

• timestamps: adds time of when this Event has happened.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

at: SystemTime

Available on crate feature timestamps only.

SystemTime when this Event has happened.

value: T

Actual value of this Event.

Implementations

impl<T> Event<T>

pub fn new(value: T) -> Self

Creates a new Event out of the given value.

pub fn into_inner(self) -> T

Unwraps the inner Event::value loosing all the attached metadata.

pub fn split(self) -> (T, Metadata)

Splits this Event to the inner Event::value and its detached metadata.

pub fn insert<V>(self, value: V) -> Event<V>

Replaces the inner Event::value with the given one, dropping the old one in place.

pub fn map<V>(self, f: impl FnOnce(T) -> V) -> Event<V>

Maps the inner Event::value with the given function.

pub fn replace<V>(self, value: V) -> (T, Event<V>)

Replaces the inner Event::value with the given one, returning the old one along.

impl Event<()>

pub fn wrap<V>(self, value: V) -> Event<V>

Wraps the given value with this Event metadata.

Trait Implementations

impl<T: ?Sized> AsRef<T> for Event<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone + ?Sized> Clone for Event<T>

fn clone(&self) -> Event<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ?Sized> Debug for Event<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Deref for Event<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: ?Sized> DerefMut for Event<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: Copy + ?Sized> Copy for Event<T>