Struct near_sdk::collections::UnorderedMap

pub struct UnorderedMap<K, V> { /* fields omitted */ }

An iterable implementation of a map that stores its content directly on the trie.

Implementations

impl<K, V> UnorderedMap<K, V>

pub fn len(&self) -> u64

Returns the number of elements in the map, also referred to as its size.

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

pub fn new<S>(prefix: S) -> Self where
    S: IntoStorageKey, 

Create new map with zero elements. Use prefix as a unique identifier.

pub fn insert_raw(
    &mut self,
    key_raw: &[u8],
    value_raw: &[u8]
) -> Option<Vec<u8>>

Inserts a serialized key-value pair into the map. If the map did not have this key present, None is returned. Otherwise returns a serialized value. Note, the keys that have the same hash value are undistinguished by the implementation.

pub fn remove_raw(&mut self, key_raw: &[u8]) -> Option<Vec<u8>>

Removes a serialized key from the map, returning the serialized value at the key if the key was previously in the map.

impl<K, V> UnorderedMap<K, V> where
    K: BorshSerialize + BorshDeserialize,
    V: BorshSerialize + BorshDeserialize, 

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

Returns the value corresponding to the key.

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

Removes a key from the map, returning the value at the key if the key was previously in the map.

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

Inserts a key-value pair into the map. If the map did not have this key present, None is returned. Otherwise returns a value. Note, the keys that have the same hash value are undistinguished by the implementation.

pub fn clear(&mut self)

Clears the map, removing all elements.

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

Copies elements into an std::vec::Vec.

pub fn keys(&self) -> impl Iterator<Item = K> + '_

An iterator visiting all keys. The iterator element type is K.

pub fn values(&self) -> impl Iterator<Item = V> + '_

An iterator visiting all values. The iterator element type is V.

pub fn iter(&self) -> impl Iterator<Item = (K, V)> + '_

Iterate over deserialized keys and values.

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

pub fn keys_as_vector(&self) -> &Vector<K>

Returns a view of keys as a vector. It’s sometimes useful to have random access to the keys.

pub fn values_as_vector(&self) -> &Vector<V>

Returns a view of values as a vector. It’s sometimes useful to have random access to the values.

Trait Implementations

impl<K, V> BorshDeserialize for UnorderedMap<K, V> where
    Vec<u8>: BorshDeserialize,
    Vector<K>: BorshDeserialize,
    Vector<V>: BorshDeserialize, 

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn is_u8() -> bool

Whether Self is u8. NOTE: Vec<u8> is the most common use-case for serialization and deserialization, it’s worth handling it as a special case to improve performance. It’s a workaround for specific Vec<u8> implementation versus generic Vec<T> implementation. See https://github.com/rust-lang/rfcs/pull/1210 for details.

impl<K, V> BorshSerialize for UnorderedMap<K, V> where
    Vec<u8>: BorshSerialize,
    Vector<K>: BorshSerialize,
    Vector<V>: BorshSerialize, 

fn serialize<W: Write>(&self, writer: &mut W) -> Result<(), Error>

fn try_to_vec(&self) -> Result<Vec<u8, Global>, Error>

Serialize this instance into a vector of bytes.

fn is_u8() -> bool

Whether Self is u8. NOTE: Vec<u8> is the most common use-case for serialization and deserialization, it’s worth handling it as a special case to improve performance. It’s a workaround for specific Vec<u8> implementation versus generic Vec<T> implementation. See https://github.com/rust-lang/rfcs/pull/1210 for details.