Struct near_sdk::collections::TreeMap

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

TreeMap based on AVL-tree

Runtime complexity (worst case):

• get/contains_key: O(1) - UnorderedMap lookup
• insert/remove: O(log(N))
• min/max: O(log(N))
• above/below: O(log(N))
• range of K elements: O(Klog(N))

Implementations

impl<K, V> TreeMap<K, V> where
    K: Ord + Clone + BorshSerialize + BorshDeserialize,
    V: BorshSerialize + BorshDeserialize, 

pub fn new(id: Vec<u8>) -> Self

pub fn len(&self) -> u64

pub fn clear(&mut self)

pub fn contains_key(&self, key: &K) -> bool

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

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

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

pub fn min(&self) -> Option<K>

Returns the smallest stored key from the tree

pub fn max(&self) -> Option<K>

Returns the largest stored key from the tree

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

Returns the smallest key that is strictly greater than key given as the parameter

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

Returns the largest key that is strictly less than key given as the parameter

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

Returns the smallest key that is greater or equal to key given as the parameter

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

Returns the largest key that is less or equal to key given as the parameter

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

Iterate all entries in ascending order: min to max, both inclusive

pub fn iter_from<'a>(&'a self, key: K) -> impl Iterator<Item = (K, V)> + 'a

Iterate entries in ascending order: given key (exclusive) to max (inclusive)

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

Iterate all entries in descending order: max to min, both inclusive

pub fn iter_rev_from<'a>(&'a self, key: K) -> impl Iterator<Item = (K, V)> + 'a

Iterate entries in descending order: given key (exclusive) to min (inclusive)

pub fn range<'a>(
    &'a self,
    r: (Bound<K>, Bound<K>)
) -> impl Iterator<Item = (K, V)> + 'a

Iterate entries in ascending order according to specified bounds.

Panics

Panics if range start > end. Panics if range start == end and both bounds are Excluded.

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

Trait Implementations

impl<K, V> BorshDeserialize for TreeMap<K, V> where
    u64: BorshDeserialize,
    UnorderedMap<K, V>: BorshDeserialize,
    Vector<Node<K>>: 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 TreeMap<K, V> where
    u64: BorshSerialize,
    UnorderedMap<K, V>: BorshSerialize,
    Vector<Node<K>>: BorshSerialize, 

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

fn try_to_vec(&self) -> Result<Vec<u8>, 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.

impl<K, V> Default for TreeMap<K, V> where
    K: Ord + Clone + BorshSerialize + BorshDeserialize,
    V: BorshSerialize + BorshDeserialize, 

fn default() -> Self

Returns the "default value" for a type.

impl<'a, K, V> IntoIterator for &'a TreeMap<K, V> where
    K: Ord + Clone + BorshSerialize + BorshDeserialize,
    V: BorshSerialize + BorshDeserialize, 

type Item = (K, V)

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.