Struct Key

pub struct Key<'k> { /* private fields */ }

A key in a key-value.

Implementations

impl<'k> Key<'k>

pub fn from_str(key: &'k str) -> Self

Get a key from a borrowed string.

pub fn as_str(&self) -> &str

Get a borrowed string from this key.

The lifetime of the returned string is bound to the borrow of self rather than to 'k.

pub fn to_borrowed_str(&self) -> Option<&'k str>

Try get a borrowed string for the lifetime 'k from this key.

If the key is a borrow of a longer lived string, this method will return Some. If the key is internally buffered, this method will return None.

Trait Implementations

impl<'k> AsRef<str> for Key<'k>

fn as_ref(&self) -> &str

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

impl<'k> Borrow<str> for Key<'k>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<'k> Clone for Key<'k>

fn clone(&self) -> Key<'k>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'k> Debug for Key<'k>

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

Formats the value using the given formatter.

impl<'k> Display for Key<'k>

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

Formats the value using the given formatter.

impl<'k> From<&'k str> for Key<'k>

fn from(s: &'k str) -> Self

Converts to this type from the input type.

impl<'k> Hash for Key<'k>

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

fn cmp(&self, other: &Key<'k>) -> 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<'k> PartialEq for Key<'k>

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

fn partial_cmp(&self, other: &Key<'k>) -> 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<'k> ToKey for Key<'k>

fn to_key(&self) -> Key<'_>

Perform the conversion.

impl<'k> Eq for Key<'k>

impl<'k> StructuralPartialEq for Key<'k>