Skip to main content

Event

Struct Event 

Source
pub struct Event {
    pub level: Level,
    pub code: &'static str,
    pub value: Option<f32>,
}
Expand description

A structured telemetry event.

An event pairs a Level with a stable, short code - a label such as "battery.low" or "link.lost" rather than a free-form message - so events stay tiny, group cleanly into counts, and need no allocation. An optional value carries an associated measurement, such as the battery level that triggered it.

Fields§

§level: Level

The event’s severity.

§code: &'static str

A stable, short identifier for what happened.

§value: Option<f32>

An optional measurement associated with the event.

Implementations§

Source§

impl Event

Source

pub fn new(level: Level, code: &'static str) -> Self

Creates an event at level with the given code and no value.

§Arguments
  • level - the event’s severity.
  • code - a stable, short identifier for the event.
§Returns

The event.

Source

pub fn trace(code: &'static str) -> Self

Creates a Level::Trace event.

§Arguments
  • code - a stable, short identifier for the event.
§Returns

The event.

Source

pub fn debug(code: &'static str) -> Self

Creates a Level::Debug event.

§Arguments
  • code - a stable, short identifier for the event.
§Returns

The event.

Source

pub fn info(code: &'static str) -> Self

Creates a Level::Info event.

§Arguments
  • code - a stable, short identifier for the event.
§Returns

The event.

Source

pub fn warn(code: &'static str) -> Self

Creates a Level::Warn event.

§Arguments
  • code - a stable, short identifier for the event.
§Returns

The event.

Source

pub fn error(code: &'static str) -> Self

Creates a Level::Error event.

§Arguments
  • code - a stable, short identifier for the event.
§Returns

The event.

Source

pub fn with_value(self, value: f32) -> Self

Attaches a measurement to the event.

§Arguments
  • value - the measurement to associate with the event.
§Returns

The event, for chaining.

Trait Implementations§

Source§

impl Clone for Event

Source§

fn clone(&self) -> Event

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Event

Source§

impl Debug for Event

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Event

Source§

fn eq(&self, other: &Event) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Event

Auto Trait Implementations§

§

impl Freeze for Event

§

impl RefUnwindSafe for Event

§

impl Send for Event

§

impl Sync for Event

§

impl Unpin for Event

§

impl UnsafeUnpin for Event

§

impl UnwindSafe for Event

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.