Trait dock_core::util::key_value::KeyValue

pub trait KeyValue: Sized {
    type Key: Ord + Clone;
    type Value: Clone;
    type Keys<'keys>: Iterator<Item = &'keys Self::Key> + 'keys
       where Self: 'keys,
             Self::Key: 'keys;

    // Required methods
    fn capacity(&self) -> Option<u32>;
    fn len(&self) -> u32;
    fn get<K: Borrow<Self::Key>>(&self, key: K) -> Option<&Self::Value>;
    fn take<K: Borrow<Self::Key>>(&mut self, key: K) -> Option<Self::Value>;
    fn try_add(
        &mut self,
        key: Self::Key,
        value: Self::Value
    ) -> Result<(), (Self::Key, Self::Value)>;
    fn keys(&self) -> Self::Keys<'_>;

    // Provided methods
    fn is_empty(&self) -> bool { ... }
    fn contains_key<K: Borrow<Self::Key>>(&self, key: K) -> bool { ... }
}

Key-value container with capacity.

Required Associated Types

type Key: Ord + Clone

type Value: Clone

type Keys<'keys>: Iterator<Item = &'keys Self::Key> + 'keys where Self: 'keys, Self::Key: 'keys

Required Methods

fn capacity(&self) -> Option<u32>

Container capacity.

fn len(&self) -> u32

Amount of the contained items.

fn get<K: Borrow<Self::Key>>(&self, key: K) -> Option<&Self::Value>

Returns value asssociated with the given key.

fn take<K: Borrow<Self::Key>>(&mut self, key: K) -> Option<Self::Value>

Takes value asssociated with the given key.

fn try_add( &mut self, key: Self::Key, value: Self::Value ) -> Result<(), (Self::Key, Self::Value)>

Attempts to insert item in the underlying container.

fn keys(&self) -> Self::Keys<'_>

Produces an iterator emitting underlying keys.

Provided Methods

fn is_empty(&self) -> bool

Returns true if the underlying container is empty.

fn contains_key<K: Borrow<Self::Key>>(&self, key: K) -> bool

Returns true if the underlying container has given the key.

Implementations on Foreign Types

impl<K: Ord + Clone, V: Clone, S: Get<u32>> KeyValue for BoundedBTreeMap<K, V, S>

type Key = K

type Value = V

type Keys<'keys> where Self: 'keys, K: 'keys = Keys<'keys, K, V>

fn capacity(&self) -> Option<u32>

fn len(&self) -> u32

fn get<Key: Borrow<Self::Key>>(&self, key: Key) -> Option<&Self::Value>

fn take<Key: Borrow<Self::Key>>(&mut self, key: Key) -> Option<Self::Value>

fn try_add( &mut self, key: Self::Key, value: Self::Value ) -> Result<(), (Self::Key, Self::Value)>

fn keys(&self) -> Self::Keys<'_>

impl<V: Ord + Clone> KeyValue for BTreeSet<V>

type Key = V

type Value = ()

type Keys<'keys> where Self: 'keys, V: 'keys = Iter<'keys, V>

fn capacity(&self) -> Option<u32>

fn len(&self) -> u32

fn get<Key: Borrow<Self::Key>>(&self, key: Key) -> Option<&Self::Value>

fn take<Key: Borrow<Self::Key>>(&mut self, key: Key) -> Option<Self::Value>

fn try_add( &mut self, key: Self::Key, (): Self::Value ) -> Result<(), (Self::Key, Self::Value)>

fn keys(&self) -> Self::Keys<'_>

impl<K: Ord + Clone, V: Clone> KeyValue for BTreeMap<K, V>

type Key = K

type Value = V

type Keys<'keys> where Self: 'keys, K: 'keys = Keys<'keys, K, V>

fn capacity(&self) -> Option<u32>

fn len(&self) -> u32

fn get<Key: Borrow<Self::Key>>(&self, key: Key) -> Option<&Self::Value>

fn take<Key: Borrow<Self::Key>>(&mut self, key: Key) -> Option<Self::Value>

fn try_add( &mut self, key: Self::Key, value: Self::Value ) -> Result<(), (Self::Key, Self::Value)>

fn keys(&self) -> Self::Keys<'_>

impl<V: Ord + Clone, S: Get<u32>> KeyValue for BoundedBTreeSet<V, S>

type Key = V

type Value = ()

type Keys<'keys> where Self: 'keys, V: 'keys = Iter<'keys, V>

fn capacity(&self) -> Option<u32>

fn len(&self) -> u32

fn get<Key: Borrow<Self::Key>>(&self, key: Key) -> Option<&Self::Value>

fn take<Key: Borrow<Self::Key>>(&mut self, key: Key) -> Option<Self::Value>

fn try_add( &mut self, key: Self::Key, (): Self::Value ) -> Result<(), (Self::Key, Self::Value)>

fn keys(&self) -> Self::Keys<'_>

Implementors