Struct SpanBuilder 

pub struct SpanBuilder<S, T = S> {
    pub parents: Vec<Span<S, T>>,
    pub current_span: Span<S, T>,
}

A builder to create a Span. S is the type of span names and T is the type of item names.

Fields

parents: Vec<Span<S, T>>

current_span: Span<S, T>

Implementations

impl<S, T> SpanBuilder<S, T>

where S: Display, T: Ord + Display + Hash,

pub fn new(name: S) -> Self

Create an empty builder with the given name for the root span.

pub fn item(&mut self, item_name: impl Into<T>) -> &mut Self

where T: Hash + Eq,

Add an item to this span.

pub fn enter(&mut self, span_name: S) -> &mut Self

Enter a new child span with the given name.

pub fn exit(&mut self) -> Result<&mut Self, SpanBuilderExitError>

where T: Clone + Hash + Eq,

Exit the current span, moving back to its parent.

Yields an error if the current span is the root span, which may not be exited.

pub fn finish(self) -> Result<Span<S, T>, SpanBuilderFinishError>

Get the root span, consuming the builder.

Yields an error if the current span is not the root span.

Trait Implementations

impl<S: Clone, T: Clone> Clone for SpanBuilder<S, T>

fn clone(&self) -> SpanBuilder<S, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug, T: Debug> Debug for SpanBuilder<S, T>

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

Formats the value using the given formatter.