Struct TraceContext 

pub struct TraceContext {
    pub trace_id: TraceId,
    pub span_id: SpanId,
    pub flags: SamplingFlags,
}

A parsed W3C traceparent header value.

Holds a TraceId, a SpanId, and SamplingFlags. Only spec version 00 is accepted; future versions with extra fields will be rejected.

Parsing

use api_bones::traceparent::{TraceContext, SamplingFlags};

let tc: TraceContext =
    "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01"
        .parse()
        .unwrap();

assert!(tc.flags.is_sampled());

Serialization

Display produces the canonical traceparent string which can be used directly as an HTTP header value.

Fields

trace_id: TraceId

128-bit trace identifier.

span_id: SpanId

64-bit parent span identifier.

flags: SamplingFlags

Sampling and other flags.

Implementations

impl TraceContext

pub fn new() -> Self

Create a new TraceContext with fresh random IDs and the sampled flag set.

use api_bones::traceparent::TraceContext;

let tc = TraceContext::new();
assert!(tc.flags.is_sampled());

pub fn child_span(&self) -> Self

Create a new child span — same trace_id, new span_id.

use api_bones::traceparent::TraceContext;

let parent = TraceContext::new();
let child = parent.child_span();
assert_eq!(child.trace_id, parent.trace_id);
assert_ne!(child.span_id, parent.span_id);

pub fn header_value(&self) -> String

Produce the canonical traceparent header value string.

Equivalent to self.to_string().

pub fn header_name(&self) -> &'static str

The canonical HTTP header name: traceparent.

use api_bones::traceparent::TraceContext;

let tc = TraceContext::new();
assert_eq!(tc.header_name(), "traceparent");

Trait Implementations

impl Clone for TraceContext

fn clone(&self) -> TraceContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TraceContext

impl Debug for TraceContext

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

Formats the value using the given formatter.

impl Default for TraceContext

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TraceContext

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for TraceContext

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

Formats the value using the given formatter.

impl Eq for TraceContext

impl FromStr for TraceContext

fn from_str(s: &str) -> Result<Self, Self::Err>

Parse a traceparent header value.

Only version 00 is accepted. Extra fields beyond the four standard ones are rejected per spec (future-version compatibility is the caller’s responsibility).

type Err = TraceContextError

The associated error which can be returned from parsing.

impl Hash for TraceContext

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 HeaderId for TraceContext

Available on crate feature std only.

const HEADER_NAME: &'static str = "traceparent"

The canonical HTTP header name for this type.

fn as_str(&self) -> Cow<'_, str>

Return the string representation of this header value.

impl PartialEq for TraceContext

fn eq(&self, other: &TraceContext) -> 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 Serialize for TraceContext

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TraceContext