Struct key_vec::KeyVec

pub struct KeyVec<K, V> where
    K: Ord + Clone + Debug,
    V: PartialEq,  { /* fields omitted */ }

Vec of key-value pairs sorted by key.

See crate-level documentation for examples.

Implementations

impl<K, V> KeyVec<K, V> where
    K: Ord + Clone + Debug,
    V: PartialEq, 

pub fn new() -> Self

pub fn with_capacity(capacity: usize) -> Self

pub fn insert(&mut self, key: K, value: V) -> Option<V>

Insert an (key,value) pair, returning an existing value if one was present for the corresponding key.

pub fn get(&self, key: &K) -> Option<&V>

pub fn get_mut(&mut self, key: &K) -> Option<&mut V>

pub fn remove(&mut self, key: &K) -> Option<V>

pub fn remove_index(&mut self, index: usize) -> (K, V)

Panics if index is out of bounds

pub fn pop(&mut self) -> Option<(K, V)>

pub fn clear(&mut self)

pub fn drain<R>(&mut self, range: R) -> Drain<'_, (K, V)> where
    R: RangeBounds<usize>, 

pub fn iter_mut(&mut self) -> IterMut<'_, K, V>

pub fn retain<F>(&mut self, f: F) where
    F: FnMut(&(K, V)) -> bool, 

pub fn into_vec(self) -> Vec<(K, V)>

NOTE: to_vec() is a slice method that is accessible through deref, use this instead to avoid cloning

Methods from Deref<Target = Vec<(K, V)>>

pub fn capacity(&self) -> usize

Returns the number of elements the vector can hold without reallocating.

Examples

let vec: Vec<i32> = Vec::with_capacity(10);
assert_eq!(vec.capacity(), 10);

pub fn as_slice(&self) -> &[T]

Extracts a slice containing the entire vector.

Equivalent to &s[..].

Examples

use std::io::{self, Write};
let buffer = vec![1, 2, 3, 5, 8];
io::sink().write(buffer.as_slice()).unwrap();

pub fn as_ptr(&self) -> *const T

Returns a raw pointer to the vector's buffer.

The caller must ensure that the vector outlives the pointer this function returns, or else it will end up pointing to garbage. Modifying the vector may cause its buffer to be reallocated, which would also make any pointers to it invalid.

The caller must also ensure that the memory the pointer (non-transitively) points to is never written to (except inside an UnsafeCell) using this pointer or any pointer derived from it. If you need to mutate the contents of the slice, use as_mut_ptr.

Examples

let x = vec![1, 2, 4];
let x_ptr = x.as_ptr();

unsafe {
    for i in 0..x.len() {
        assert_eq!(*x_ptr.add(i), 1 << i);
    }
}

pub fn allocator(&self) -> &A

🔬 This is a nightly-only experimental API. (allocator_api)

Returns a reference to the underlying allocator.

pub fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its 'length'.

Examples

let a = vec![1, 2, 3];
assert_eq!(a.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

Examples

let mut v = Vec::new();
assert!(v.is_empty());

v.push(1);
assert!(!v.is_empty());

Trait Implementations

impl<K: Clone, V: Clone> Clone for KeyVec<K, V> where
    K: Ord + Clone + Debug,
    V: PartialEq, 

pub fn clone(&self) -> KeyVec<K, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug, V: Debug> Debug for KeyVec<K, V> where
    K: Ord + Clone + Debug,
    V: PartialEq, 

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

Formats the value using the given formatter.

impl<K, V> Default for KeyVec<K, V> where
    K: Ord + Clone + Debug,
    V: PartialEq, 

pub fn default() -> Self

Returns the "default value" for a type.

impl<K, V> Deref for KeyVec<K, V> where
    K: Ord + Clone + Debug,
    V: PartialEq, 

type Target = Vec<(K, V)>

The resulting type after dereferencing.

pub fn deref(&self) -> &Vec<(K, V)>

Dereferences the value.

impl<K, V> Eq for KeyVec<K, V> where
    K: Ord + Clone + Debug,
    V: PartialEq + Eq, 

impl<K, V> Extend<(K, V)> for KeyVec<K, V> where
    K: Ord + Clone + Debug,
    V: PartialEq, 

pub fn extend<I: IntoIterator<Item = (K, V)>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<K, V> From<Vec<(K, V), Global>> for KeyVec<K, V> where
    K: Ord + Clone + Debug,
    V: PartialEq, 

pub fn from(vec: Vec<(K, V)>) -> Self

Uses sort_by_key() and dedup_by_key() to remove duplicate key entries.

Note that dedup_by_key() will keep the first of duplicate keys present in the input vector.

impl<K, V> FromIterator<(K, V)> for KeyVec<K, V> where
    K: Ord + Clone + Debug,
    V: PartialEq, 

pub fn from_iter<I: IntoIterator<Item = (K, V)>>(iter: I) -> Self

Creates a value from an iterator.

impl<K, V> IntoIterator for KeyVec<K, V> where
    K: Ord + Clone + Debug,
    V: PartialEq, 

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<Self::Item>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K: PartialEq, V: PartialEq> PartialEq<KeyVec<K, V>> for KeyVec<K, V> where
    K: Ord + Clone + Debug,
    V: PartialEq, 

pub fn eq(&self, other: &KeyVec<K, V>) -> bool

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

pub fn ne(&self, other: &KeyVec<K, V>) -> bool

This method tests for !=.

impl<K, V> StructuralPartialEq for KeyVec<K, V> where
    K: Ord + Clone + Debug,
    V: PartialEq,