[−][src]Struct tracing::event::Event
Event
s represent single points in time where something occurred during the
execution of a program.
An Event
can be compared to a log record in unstructured logging, but with
two key differences:
Event
s exist within the context of a span. Unlike log lines, they may be located within the trace tree, allowing visibility into the temporal context in which the event occurred, as well as the source code location.- Like spans,
Event
s have structured key-value data known as fields, which may include textual message. In general, a majority of the data associated with an event should be in the event's fields rather than in the textual message, as the fields are more structured.
Methods
impl<'a> Event<'a>
[src]
pub fn dispatch(metadata: &'static Metadata<'static>, fields: &'a ValueSet)
[src]
Constructs a new Event
with the specified metadata and set of values,
and observes it with the current subscriber.
pub fn new(
metadata: &'static Metadata<'static>,
fields: &'a ValueSet<'a>
) -> Event<'a>
[src]
metadata: &'static Metadata<'static>,
fields: &'a ValueSet<'a>
) -> Event<'a>
Returns a new Event
in the current span, with the specified metadata
and set of values.
pub fn new_child_of<impl Into
[src]
Returns a new Event
as a child of the specified span, with the
provided metadata and set of values.
pub fn child_of<impl Into>>(
parent: impl Into >,
metadata: &'static Metadata<'static>,
fields: &'a ValueSet
) where
impl Into>: Into<Option<Id>>,
[src]
parent: impl Into
metadata: &'static Metadata<'static>,
fields: &'a ValueSet
) where
impl Into
Constructs a new Event
with the specified metadata and set of values,
and observes it with the current subscriber and an explicit parent.
pub fn record(&self, visitor: &mut dyn Visit)
[src]
Visits all the fields on this Event
with the specified visitor.
ⓘImportant traits for Iterpub fn fields(&self) -> Iter
[src]
Returns an iterator over the set of values on this Event
.
pub fn metadata(&self) -> &'static Metadata<'static>
[src]
Returns metadata describing this Event
.
pub fn is_root(&self) -> bool
[src]
Returns true if the new event should be a root.
pub fn is_contextual(&self) -> bool
[src]
Returns true if the new event's parent should be determined based on the current context.
If this is true and the current thread is currently inside a span, then that span should be the new event's parent. Otherwise, if the current thread is not inside a span, then the new event will be the root of its own trace tree.
pub fn parent(&self) -> Option<&Id>
[src]
Returns the new event's explicitly-specified parent, if there is one.
Otherwise (if the new event is a root or is a child of the current span), returns false.
Trait Implementations
Auto Trait Implementations
impl<'a> !Send for Event<'a>
impl<'a> Unpin for Event<'a>
impl<'a> !Sync for Event<'a>
impl<'a> !UnwindSafe for Event<'a>
impl<'a> !RefUnwindSafe for Event<'a>
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,