Struct tracing_core::span::Attributes
source · [−]pub struct Attributes<'a> { /* private fields */ }Expand description
Attributes provided to a Subscriber describing a new span when it is
created.
Implementations
sourceimpl<'a> Attributes<'a>
impl<'a> Attributes<'a>
sourcepub fn new(
metadata: &'static Metadata<'static>,
values: &'a ValueSet<'a>
) -> Self
pub fn new(
metadata: &'static Metadata<'static>,
values: &'a ValueSet<'a>
) -> Self
Returns Attributes describing a new child span of the current span,
with the provided metadata and values.
sourcepub fn new_root(
metadata: &'static Metadata<'static>,
values: &'a ValueSet<'a>
) -> Self
pub fn new_root(
metadata: &'static Metadata<'static>,
values: &'a ValueSet<'a>
) -> Self
Returns Attributes describing a new span at the root of its own trace
tree, with the provided metadata and values.
sourcepub fn child_of(
parent: Id,
metadata: &'static Metadata<'static>,
values: &'a ValueSet<'a>
) -> Self
pub fn child_of(
parent: Id,
metadata: &'static Metadata<'static>,
values: &'a ValueSet<'a>
) -> Self
Returns Attributes describing a new child span of the specified
parent span, with the provided metadata and values.
sourcepub fn metadata(&self) -> &'static Metadata<'static>
pub fn metadata(&self) -> &'static Metadata<'static>
Returns a reference to the new span’s metadata.
sourcepub fn values(&self) -> &ValueSet<'a>
pub fn values(&self) -> &ValueSet<'a>
Returns a reference to a ValueSet containing any values the new span
was created with.
sourcepub fn is_contextual(&self) -> bool
pub fn is_contextual(&self) -> bool
Returns true if the new span’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 span’s parent. Otherwise, if the current thread is not inside a span, then the new span will be the root of its own trace tree.
sourcepub fn parent(&self) -> Option<&Id>
pub fn parent(&self) -> Option<&Id>
Returns the new span’s explicitly-specified parent, if there is one.
Otherwise (if the new span is a root or is a child of the current span),
returns None.
sourcepub fn record(&self, visitor: &mut dyn Visit)
pub fn record(&self, visitor: &mut dyn Visit)
Records all the fields in this set of Attributes with the provided
Visitor.
sourcepub fn contains(&self, field: &Field) -> bool
pub fn contains(&self, field: &Field) -> bool
Returns true if this set of Attributes contains a value for the
given Field.
sourcepub fn fields(&self) -> &FieldSet
pub fn fields(&self) -> &FieldSet
Returns the set of all fields defined by this span’s Metadata.
Note that the FieldSet returned by this method includes all the
fields declared by this span, not just those with values that are recorded
as part of this set of Attributes. Other fields with values not present in
this Attributes’ value set may record values later.