Struct SpanContext

pub struct SpanContext { /* private fields */ }

Immutable portion of a Span which can be serialized and propagated.

This representation conforms to the W3C TraceContext specification.

Spans that do not have the sampled flag set in their TraceFlags will be ignored by most tracing tools.

Implementations

impl SpanContext

pub const NONE: SpanContext = _

An invalid span context

pub fn empty_context() -> Self

Create an invalid empty span context

pub fn new( trace_id: TraceId, span_id: SpanId, trace_flags: TraceFlags, is_remote: bool, trace_state: TraceState, ) -> Self

Construct a new SpanContext

pub fn trace_id(&self) -> TraceId

The TraceId for this span context.

pub fn span_id(&self) -> SpanId

The SpanId for this span context.

pub fn trace_flags(&self) -> TraceFlags

Returns details about the trace.

Unlike TraceState values, these are present in all traces. The current version of the specification only supports a single flag TraceFlags::SAMPLED.

pub fn is_valid(&self) -> bool

Returns true if the span context has a valid (non-zero) trace_id and a valid (non-zero) span_id.

pub fn is_remote(&self) -> bool

Returns true if the span context was propagated from a remote parent.

pub fn is_sampled(&self) -> bool

Returns true if the sampled trace flag is set.

Spans that are not sampled will be ignored by most tracing tools.

pub fn trace_state(&self) -> &TraceState

A reference to the span context’s TraceState.

Trait Implementations

impl Clone for SpanContext

fn clone(&self) -> SpanContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpanContext

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

Formats the value using the given formatter.

impl Hash for SpanContext

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SpanContext

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for SpanContext

impl StructuralPartialEq for SpanContext