Enum ordered_multimap::list_ordered_multimap::KeyWrapper

pub enum KeyWrapper<'map, Key> {
    Borrowed(&'map Key),
    Owned(Key),
}

A wrapper around a key that is either borrowed or owned.

This type is similar to std::borrow::Cow but does not require a Clone trait bound on the key.

Variants

Borrowed(&'map Key)

An immutable reference to a key. This implies that the key is still associated to at least one value in the multimap.

Owned(Key)

An owned key. This will occur when a key is no longer associated with any values in the multimap.

Implementations

impl<Key> KeyWrapper<'_, Key>

pub fn into_owned(self) -> Keywhere
    Key: Clone,

If the key wrapped is owned, it is returned. Otherwise, the borrowed key is cloned and returned.

Examples

use ordered_multimap::list_ordered_multimap::KeyWrapper;

let borrowed = KeyWrapper::Borrowed(&0);
assert_eq!(borrowed.into_owned(), 0);

let owned = KeyWrapper::Owned(0);
assert_eq!(borrowed.into_owned(), 0);

pub fn is_borrowed(&self) -> bool

Returns whether the wrapped key is borrowed.

Examples

use ordered_multimap::list_ordered_multimap::KeyWrapper;

let borrowed = KeyWrapper::Borrowed(&0);
assert!(borrowed.is_borrowed());

let owned = KeyWrapper::Owned(0);
assert!(!owned.is_borrowed());

pub fn is_owned(&self) -> bool

Returns whether the wrapped key is owned.

Examples

use ordered_multimap::list_ordered_multimap::KeyWrapper;

let borrowed = KeyWrapper::Borrowed(&0);
assert!(!borrowed.is_owned());

let owned = KeyWrapper::Owned(0);
assert!(owned.is_owned());

Trait Implementations

impl<'map, Key: Clone> Clone for KeyWrapper<'map, Key>

fn clone(&self) -> KeyWrapper<'map, Key>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'map, Key: Debug> Debug for KeyWrapper<'map, Key>

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

Formats the value using the given formatter.

impl<'map, Key: Hash> Hash for KeyWrapper<'map, Key>

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<'map, Key: PartialEq> PartialEq<KeyWrapper<'map, Key>> for KeyWrapper<'map, Key>

fn eq(&self, other: &KeyWrapper<'map, Key>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'map, Key: Copy> Copy for KeyWrapper<'map, Key>

impl<'map, Key: Eq> Eq for KeyWrapper<'map, Key>

impl<'map, Key> StructuralEq for KeyWrapper<'map, Key>

impl<'map, Key> StructuralPartialEq for KeyWrapper<'map, Key>