Skip to main content

TraceContext

Struct TraceContext 

Source
pub struct TraceContext { /* private fields */ }
Expand description

The W3C Trace Context a client sent in a request’s _meta.

Obtain one from RequestContext::trace_context, or parse a value directly with TraceContext::parse. See the module documentation for the parsing rules.

Implementations§

Source§

impl TraceContext

Source

pub fn parse(traceparent: &str, tracestate: Option<&str>) -> Option<Self>

Parse a traceparent value and an optional tracestate value.

Returns None when traceparent is malformed. An invalid tracestate is dropped and the traceparent is kept.

Source

pub fn from_meta(meta: &Value) -> Option<Self>

Read the trace context from a request’s _meta object.

Returns None when meta is not an object or has no traceparent. A traceparent that is present but not a well-formed string discards both keys and emits a debug-level event. A tracestate that is not a string reads as absent.

Source

pub fn version(&self) -> u8

The traceparent version, 00 for every value defined today.

Source

pub fn trace_id(&self) -> &str

The trace id: 32 lowercase hex digits, never all zeros.

Source

pub fn parent_id(&self) -> &str

The caller’s span id (parent-id): 16 lowercase hex digits, never all zeros. The server’s own span is a child of this one.

Source

pub fn trace_flags(&self) -> u8

The raw trace-flags byte.

Source

pub fn sampled(&self) -> bool

Whether the caller set the sampled flag (bit 0 of the flags).

Source

pub fn tracestate(&self) -> Option<&str>

The raw tracestate string, if one was sent and it passed the length and member-count limits.

Source

pub fn traceparent(&self) -> String

The traceparent value for this context, formatted as version-trace-id-parent-id-trace-flags.

A context parsed from a later traceparent version formats with that version and its first four fields only; trailing fields are not kept.

Source

pub fn entries(&self) -> impl Iterator<Item = (&'static str, String)> + '_

The _meta entries that carry this context: traceparent, then tracestate when there is one.

These are the exact key names the server reads, and the same pairs are what an OpenTelemetry TextMapPropagator reads from or writes to a carrier, so they can be collected into a HashMap<String, String> for extract.

use tower_mcp::TraceContext;

let ctx = TraceContext::parse(
    "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
    Some("vendor=value"),
)
.unwrap();
let entries: Vec<_> = ctx.entries().collect();
assert_eq!(entries[0].0, "traceparent");
assert_eq!(entries[1], ("tracestate", "vendor=value".to_string()));

Trait Implementations§

Source§

impl Clone for TraceContext

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TraceContext

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for TraceContext

Source§

impl PartialEq for TraceContext

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TraceContext

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more