opentelemetry::trace

Struct TraceState

Source
pub struct TraceState(/* private fields */);
Available on crate feature trace only.
Expand description

TraceState carries system-specific configuration data, represented as a list of key-value pairs. TraceState allows multiple tracing systems to participate in the same trace.

Please review the W3C specification for details on this field.

Implementations§

Source§

impl TraceState

Source

pub const NONE: TraceState = _

The default TraceState, as a constant

Source

pub fn from_key_value<T, K, V>(trace_state: T) -> TraceResult<Self>
where T: IntoIterator<Item = (K, V)>, K: ToString, V: ToString,

Creates a new TraceState from the given key-value collection.

§Examples
use opentelemetry::trace::TraceState;

let kvs = vec![("foo", "bar"), ("apple", "banana")];
let trace_state = TraceState::from_key_value(kvs);

assert!(trace_state.is_ok());
assert_eq!(trace_state.unwrap().header(), String::from("foo=bar,apple=banana"))
Source

pub fn get(&self, key: &str) -> Option<&str>

Retrieves a value for a given key from the TraceState if it exists.

Source

pub fn insert<K, V>(&self, key: K, value: V) -> TraceResult<TraceState>
where K: Into<String>, V: Into<String>,

Inserts the given key-value pair into the TraceState. If a value already exists for the given key, this updates the value and updates the value’s position. If the key or value are invalid per the W3 Spec an Err is returned, else a new TraceState with the updated key/value is returned.

Source

pub fn delete<K: Into<String>>(&self, key: K) -> TraceResult<TraceState>

Removes the given key-value pair from the TraceState. If the key is invalid per the W3 Spec an Err is returned. Else, a new TraceState with the removed entry is returned.

If the key is not in TraceState. The original TraceState will be cloned and returned.

Source

pub fn header(&self) -> String

Creates a new TraceState header string, delimiting each key and value with a = and each entry with a ,.

Source

pub fn header_delimited( &self, entry_delimiter: &str, list_delimiter: &str, ) -> String

Creates a new TraceState header string, with the given key/value delimiter and entry delimiter.

Trait Implementations§

Source§

impl Clone for TraceState

Source§

fn clone(&self) -> TraceState

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TraceState

Source§

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

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

impl Default for TraceState

Source§

fn default() -> TraceState

Returns the “default value” for a type. Read more
Source§

impl FromStr for TraceState

Source§

type Err = TraceError

The associated error which can be returned from parsing.
Source§

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

Parses a string s to return a value of this type. Read more
Source§

impl Hash for TraceState

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for TraceState

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for TraceState

Source§

impl StructuralPartialEq for TraceState

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<T> CloneToUninit for T
where T: Clone,

Source§

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

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Available on crate feature trace only.
Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Available on crate feature trace only.
Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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