Struct rkyv::collections::btree_map::ArchivedBTreeMap

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

An archived BTreeMap.

Implementations

impl<K, V> ArchivedBTreeMap<K, V>

pub fn contains_key<Q: Ord + ?Sized>(&self, key: &Q) -> boolwhere K: Borrow<Q> + Ord,

Returns true if the map contains a value for the specified key.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

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

Returns a reference to the value corresponding to the key.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn get_key_value<Q: Ord + ?Sized>(&self, k: &Q) -> Option<(&K, &V)>where K: Borrow<Q> + Ord,

Returns the key-value pair corresponding to the supplied key.

The supplied key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

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

Gets an iterator over the entries of the map, sorted by key.

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

Gets an iterator over the keys of the map, in sorted order.

pub fn len(&self) -> usize

Returns the number of items in the archived B-tree map.

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

Gets an iterator over the values of the map, in order by key.

pub unsafe fn resolve_from_len( len: usize, pos: usize, resolver: BTreeMapResolver, out: *mut Self )

Resolves a B-tree map from its length.

Safety

• len must be the number of elements that were serialized
• pos must be the position of out within the archive
• resolver must be the result of serializing a B-tree map

impl<K, V> ArchivedBTreeMap<K, V>

pub unsafe fn serialize_from_reverse_iter<'a, UK, UV, S, I>( iter: I, serializer: &mut S ) -> Result<BTreeMapResolver, S::Error>where UK: 'a + Serialize<S, Archived = K>, UV: 'a + Serialize<S, Archived = V>, S: Serializer + ?Sized, I: ExactSizeIterator<Item = (&'a UK, &'a UV)>,

Serializes an ordered iterator of key-value pairs as a B-tree map.

Safety

• Keys returned by the iterator must be unique
• Keys must be in reverse sorted order from last to first

Trait Implementations

impl<K, V, C> CheckBytes<C> for ArchivedBTreeMap<K, V>where K: CheckBytes<C> + Ord, V: CheckBytes<C>, C: ArchiveContext + ?Sized, C::Error: Error,

type Error = ArchivedBTreeMapError<<K as CheckBytes<C>>::Error, <V as CheckBytes<C>>::Error, <C as Fallible>::Error>

The error that may result from checking the type.

unsafe fn check_bytes<'a>( value: *const Self, context: &mut C ) -> Result<&'a Self, Self::Error>

Checks whether the given pointer points to a valid value within the given context.

impl<K: Debug, V: Debug> Debug for ArchivedBTreeMap<K, V>

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

Formats the value using the given formatter.

impl<K: Archive + Ord, V: Archive, D: Fallible + ?Sized> Deserialize<BTreeMap<K, V, Global>, D> for ArchivedBTreeMap<K::Archived, V::Archived>where K::Archived: Deserialize<K, D> + Ord, V::Archived: Deserialize<V, D>,

fn deserialize(&self, deserializer: &mut D) -> Result<BTreeMap<K, V>, D::Error>

Deserializes using the given deserializer

impl<K: Hash, V: Hash> Hash for ArchivedBTreeMap<K, V>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<K, Q, V> Index<&Q> for ArchivedBTreeMap<K, V>where K: Borrow<Q> + Ord, Q: Ord + ?Sized,

type Output = V

The returned type after indexing.

fn index(&self, key: &Q) -> &V

Performs the indexing (container[index]) operation.

impl<'a, K, V> IntoIterator for &'a ArchivedBTreeMap<K, V>

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

The type of the elements being iterated over.

type IntoIter = Iter<'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: Ord, V: Ord> Ord for ArchivedBTreeMap<K, V>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<K, V, AK: PartialEq<K>, AV: PartialEq<V>> PartialEq<ArchivedBTreeMap<AK, AV>> for BTreeMap<K, V>

fn eq(&self, other: &ArchivedBTreeMap<AK, AV>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K: PartialEq, V: PartialEq> PartialEq<ArchivedBTreeMap<K, V>> for ArchivedBTreeMap<K, V>

fn eq(&self, other: &Self) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K, V, AK: PartialEq<K>, AV: PartialEq<V>> PartialEq<BTreeMap<K, V, Global>> for ArchivedBTreeMap<AK, AV>

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K: PartialOrd, V: PartialOrd> PartialOrd<ArchivedBTreeMap<K, V>> for ArchivedBTreeMap<K, V>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<K: Eq, V: Eq> Eq for ArchivedBTreeMap<K, V>