Struct blaze_pk::TdfMap

pub struct TdfMap<K: MapKey, V: Codec> { /* private fields */ }

Structure for Tdf maps these are maps that are created from two Vec so they retain insertion order but are slow for lookups. This implementation guarantees the lengths of both lists are the same

Implementations

impl<K: MapKey, V: Codec> TdfMap<K, V>

pub fn new() -> TdfMap<K, V>

Creates a new empty TdfMap

pub fn with_capacity(capacity: usize) -> Self

Creates a new empty TdfMap sized to account for the provided capacity of contents

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

Insert a new entry into the map

pub fn insert_multiple(&mut self, entries: impl IntoIterator<Item = (K, V)>)

Inserts multiple entries from an iterable value (i.e. Vec / slice of key value tuples)

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

Removes a value by its key and returns the entry that was present at that position.

pub fn get<Q: ?Sized>(&self, key: &Q) -> Option<&V>where
    K: Borrow<Q>,
    Q: Eq,

Returns the value stored at the provided key if its present or None.

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

Takes the value stored at the provided key out of the map taking ownership this also removes the key.

pub fn keys(&self) -> Iter<'_, K>

Iterator access for the map keys

pub fn values(&self) -> Iter<'_, V>

Iterator access for the map values

pub fn len(&self) -> usize

Returns the length of this map

Trait Implementations

impl<K: Clone + MapKey, V: Clone + Codec> Clone for TdfMap<K, V>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: MapKey, V: Codec> Codec for TdfMap<K, V>

fn encode(&self, output: &mut Vec<u8>)

Function for implementing encoding of Self to the provided vec of bytes

fn decode(reader: &mut Reader<'_>) -> CodecResult<Self>

Function for implementing decoding of Self from the provided Reader. Will return None if self cannot be decoded

fn value_type() -> ValueType

Optional additional specifier for Tdf types that tells which type this is

fn skip(reader: &mut Reader<'_>) -> CodecResult<()>

Function to provide functionality for skipping this data type (e.g. read the bytes without using them)

fn encode_bytes(&self) -> Vec<u8>

Shortcut function for encoding self directly to a Vec of bytes

impl<K: Debug + MapKey, V: Debug + Codec> Debug for TdfMap<K, V>

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

Formats the value using the given formatter.

impl<K: MapKey, V: Codec> From<HashMap<K, V, RandomState>> for TdfMap<K, V>

Implementation for converting a HashMap to a TdfMap by taking all its keys and values and building lists for the TdfMap

fn from(map: HashMap<K, V>) -> Self

Converts to this type from the input type.

impl<'a, K: MapKey, V: Codec> IntoIterator for &'a TdfMap<K, V>

type Item = (&'a K, &'a V)

The type of the elements being iterated over.

type IntoIter = TdfMapIter<'a, K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.