Struct blaze_pk::types::TdfMap

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

Structure for maps used in the protocol. These maps have a special order that is usually required and they retain the order of insertion because it uses two vecs as the underlying structure

Implementations

impl<K, V> TdfMap<K, V>

pub fn new() -> Self

Constructor implemention just uses the underlying default implemenation

pub fn with_capacity(capacity: usize) -> Self

Function for creating a new TdfMap where the underlying lists have an initial capacity

capacity The capacity

pub fn len(&self) -> usize

Returns the length of the underlying lists

pub fn is_empty(&self) -> bool

Returns if the underlying lists are empty

pub fn iter(&self) -> MapEntryIter<'_, K, V>

Creates a new iterator over the underlying items in the map

pub fn index(&self, index: usize) -> Option<(&K, &V)>

Returns the key and value stored at the provided index will return None if there is nothing at the provided index

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

Inserts a new key value pair into the underlying structure.

This function does NOT maintain order of the entires, use insert_ordered instead for maintaining the order

key The entry key value The entry value

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

Removes the last key and value returning them or None if there are no entries

pub fn clear(&mut self)

Removes all entries from the underlying list

impl<K, V> TdfMap<K, V>where K: PartialOrd + Ord,

pub fn order(&mut self)

Orders this map based on its keys by ordering keys that are greater further up in the map

This function is quite slow compared to using insert_ordered for all the inserted entries. This is only for if you inserted with insert instead

impl<K, V> TdfMap<K, V>where K: PartialEq + Eq,

pub fn extend(&mut self, other: TdfMap<K, V>)

Extends this map with the contents of another map. Any keys that already exist in the map will be replaced with the keys from the other map and any keys not present will be inserted

other The map to extend with

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.

key The key to remove

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

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

key The key to retrieve the value for

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

Returns a mutable borrow to the value stored at the provided key if its present or None.

key The key to retrieve the value for

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

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

Trait Implementations

impl<K, V> Clone for TdfMap<K, V>where K: Clone, V: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K, V> Debug for TdfMap<K, V>where K: Debug, V: Debug,

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

Formats the value using the given formatter.

impl<K, V> Decodable for TdfMap<K, V>where K: Decodable + ValueType, V: Decodable + ValueType,

fn decode(reader: &mut TdfReader<'_>) -> DecodeResult<Self>

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

impl<K, V> Default for TdfMap<K, V>

fn default() -> Self

Returns the “default value” for a type.

impl<K, V> Encodable for TdfMap<K, V>where K: Encodable + ValueType, V: Encodable + ValueType,

fn encode(&self, output: &mut TdfWriter)

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

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

Shortcut function for encoding self directly to a Vec of bytes

impl<K, V> 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, V> IntoIterator for &'a TdfMap<K, V>

Into iterator implementation for borrowed map

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

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K, V> IntoIterator for TdfMap<K, V>

Into iterator implementation for owned map

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = OwnedMapEntryIter<K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K, V> Serialize for TdfMap<K, V>where K: Serialize, V: Serialize,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where S: Serializer,

Serialize this value into the given Serde serializer.

impl<K, V> ValueType for TdfMap<K, V>

fn value_type() -> TdfType

The type of tdf value this is