Struct SpanContext

pub struct SpanContext { /* private fields */ }

Available on crate feature trace only.

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

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

Implementations

impl SpanContext

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

A valid trace identifier is a non-zero u128.

pub fn span_id(&self) -> SpanId

A valid span identifier is a non-zero u64.

pub fn trace_flags(&self) -> TraceFlags

Returns details about the trace. Unlike TraceState values, these are present in all traces. Currently, the only option is a boolean sampled flag.

pub fn is_valid(&self) -> bool

Returns a bool flag which is true if the SpanContext has a valid (non-zero) trace_id and a valid (non-zero) span_id.

pub fn is_remote(&self) -> bool

Returns true if the SpanContext 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

Returns the context’s TraceState.

Trait Implementations

impl Clone for SpanContext

fn clone(&self) -> SpanContext

Returns a duplicate of the value.

const 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<'de> Deserialize<'de> for SpanContext

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 ==.

const 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 Serialize for SpanContext

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SpanContext

impl StructuralPartialEq for SpanContext