Struct Baggage
pub struct Baggage { /* private fields */ }
Expand description
A set of name/value pairs describing user-defined properties.
§Baggage Names
- ASCII strings according to the token format, defined in [RFC2616, Section 2.2]
§Baggage Values
- URL encoded UTF-8 strings.
§Baggage Value Metadata
Additional metadata can be added to values in the form of a property set,
represented as semi-colon ;
delimited list of names and/or name/value pairs,
e.g. ;k1=v1;k2;k3=v3
.
§Limits
- Maximum number of name/value pairs:
64
. - Maximum total length of all name/value pairs:
8192
.
Implementations§
§impl Baggage
impl Baggage
pub fn get<K>(&self, key: K) -> Option<&StringValue>
pub fn get<K>(&self, key: K) -> Option<&StringValue>
Returns a reference to the value associated with a given name
§Examples
use opentelemetry::{baggage::Baggage, StringValue};
let mut baggage = Baggage::new();
let _ = baggage.insert("my-name", "my-value");
assert_eq!(baggage.get("my-name"), Some(&StringValue::from("my-value")))
pub fn get_with_metadata<K>(
&self,
key: K,
) -> Option<&(StringValue, BaggageMetadata)>
pub fn get_with_metadata<K>( &self, key: K, ) -> Option<&(StringValue, BaggageMetadata)>
Returns a reference to the value and metadata associated with a given name
§Examples
use opentelemetry::{baggage::{Baggage, BaggageMetadata}, StringValue};
let mut baggage = Baggage::new();
let _ = baggage.insert("my-name", "my-value");
// By default, the metadata is empty
assert_eq!(baggage.get_with_metadata("my-name"), Some(&(StringValue::from("my-value"), BaggageMetadata::from(""))))
pub fn insert<K, V>(&mut self, key: K, value: V) -> Option<StringValue>
pub fn insert<K, V>(&mut self, key: K, value: V) -> Option<StringValue>
Inserts a name/value pair into the baggage.
If the name was not present, None
is returned. If the name was present,
the value is updated, and the old value is returned.
§Examples
use opentelemetry::{baggage::Baggage, StringValue};
let mut baggage = Baggage::new();
let _ = baggage.insert("my-name", "my-value");
assert_eq!(baggage.get("my-name"), Some(&StringValue::from("my-value")))
pub fn insert_with_metadata<K, V, S>(
&mut self,
key: K,
value: V,
metadata: S,
) -> Option<(StringValue, BaggageMetadata)>
pub fn insert_with_metadata<K, V, S>( &mut self, key: K, value: V, metadata: S, ) -> Option<(StringValue, BaggageMetadata)>
Inserts a name/value(+metadata) pair into the baggage.
Same with insert
, if the name was not present, None
will be returned.
If the name is present, the old value and metadata will be returned.
Also checks for limits.
§Examples
use opentelemetry::{baggage::{Baggage, BaggageMetadata}, StringValue};
let mut baggage = Baggage::new();
let _ = baggage.insert_with_metadata("my-name", "my-value", "test");
assert_eq!(baggage.get_with_metadata("my-name"), Some(&(StringValue::from("my-value"), BaggageMetadata::from("test"))))
pub fn remove<K>(&mut self, key: K) -> Option<(StringValue, BaggageMetadata)>
pub fn remove<K>(&mut self, key: K) -> Option<(StringValue, BaggageMetadata)>
Removes a name from the baggage, returning the value corresponding to the name if the pair was previously in the map.
Trait Implementations§
§impl FromIterator<(Key, (StringValue, BaggageMetadata))> for Baggage
impl FromIterator<(Key, (StringValue, BaggageMetadata))> for Baggage
§impl FromIterator<KeyValue> for Baggage
impl FromIterator<KeyValue> for Baggage
§impl FromIterator<KeyValueMetadata> for Baggage
impl FromIterator<KeyValueMetadata> for Baggage
§fn from_iter<I>(iter: I) -> Baggagewhere
I: IntoIterator<Item = KeyValueMetadata>,
fn from_iter<I>(iter: I) -> Baggagewhere
I: IntoIterator<Item = KeyValueMetadata>,
§impl<'a> IntoIterator for &'a Baggage
impl<'a> IntoIterator for &'a Baggage
§type Item = (&'a Key, &'a (StringValue, BaggageMetadata))
type Item = (&'a Key, &'a (StringValue, BaggageMetadata))
Auto Trait Implementations§
impl Freeze for Baggage
impl RefUnwindSafe for Baggage
impl Send for Baggage
impl Sync for Baggage
impl Unpin for Baggage
impl UnwindSafe for Baggage
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
§fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§fn and<P, B, E>(self, other: P) -> And<T, P>
fn and<P, B, E>(self, other: P) -> And<T, P>
Policy
that returns Action::Follow
only if self
and other
return
Action::Follow
. Read more§impl<T, U> RamaTryInto<U> for Twhere
U: RamaTryFrom<T>,
impl<T, U> RamaTryInto<U> for Twhere
U: RamaTryFrom<T>,
type Error = <U as RamaTryFrom<T>>::Error
fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T>>::Error>
§impl<T, U> RamaTryInto<U> for Twhere
U: RamaTryFrom<T>,
impl<T, U> RamaTryInto<U> for Twhere
U: RamaTryFrom<T>,
type Error = <U as RamaTryFrom<T>>::Error
fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T>>::Error>
§impl<T> ToSmolStr for T
impl<T> ToSmolStr for T
fn to_smolstr(&self) -> SmolStr
§impl<T> ToStringFallible for Twhere
T: Display,
impl<T> ToStringFallible for Twhere
T: Display,
§fn try_to_string(&self) -> Result<String, TryReserveError>
fn try_to_string(&self) -> Result<String, TryReserveError>
ToString::to_string
, but without panic on OOM.