Struct Key

#[non_exhaustive]
pub struct Key(/* private fields */);

Available on crate feature opentelemetry only.

The key part of attribute KeyValue pairs.

See the attribute naming spec for guidelines.

Implementations

impl Key

pub fn new(value: impl Into<Key>) -> Key

Create a new Key.

Examples

use opentelemetry::Key;
use std::sync::Arc;

let key1 = Key::new("my_static_str");
let key2 = Key::new(String::from("my_owned_string"));
let key3 = Key::new(Arc::from("my_ref_counted_str"));

pub const fn from_static_str(value: &'static str) -> Key

Create a new const Key.

pub fn as_str(&self) -> &str

Returns a reference to the underlying key name

Trait Implementations

impl AsRef<str> for Key

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<str> for Key

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Display for Key

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

Formats the value using the given formatter.

impl From<&'static str> for Key

fn from(key_str: &'static str) -> Key

Convert a &str to a Key.

impl From<Arc<str>> for Key

fn from(string: Arc<str>) -> Key

Convert a String to a Key.

impl From<Cow<'static, str>> for Key

fn from(string: Cow<'static, str>) -> Key

Convert a Cow<'static, str> to a Key

impl From<Key> for String

fn from(key: Key) -> String

Converts to this type from the input type.

impl From<String> for Key

fn from(string: String) -> Key

Convert a String to a Key.

impl Hash for Key

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

where __H: Hasher,

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 Ord for Key

fn cmp(&self, other: &Key) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Key

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

fn partial_cmp(&self, other: &Key) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Key

impl StructuralPartialEq for Key