Struct ArchivedBTreeMap

#[repr(C)]
pub struct ArchivedBTreeMap<K, V, const E: usize = 5> { /* private fields */ }

Available on crate feature dep_rkyv only.

An archived BTreeMap.

Implementations

impl<K, V, const E: usize> ArchivedBTreeMap<K, V, E>

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

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

pub fn iter_seal( this: Seal<'_, ArchivedBTreeMap<K, V, E>>, ) -> IterSeal<'_, K, V, E>

Gets a mutable iterator over the entires of the map, sorted by key.

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

Gets an iterator over the sorted keys of the map.

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

Gets an iterator over the values of the map.

pub fn values_seal( this: Seal<'_, ArchivedBTreeMap<K, V, E>>, ) -> ValuesSeal<'_, K, V, E>

Gets a mutable iterator over the values of the map.

impl<K, V, const E: usize> ArchivedBTreeMap<K, V, E>

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

where Q: Ord + ?Sized, K: Borrow<Q> + Ord,

Returns whether the B-tree map contains the given key.

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

where Q: Ord + ?Sized, K: Borrow<Q> + Ord,

Returns the value associated with the given key, or None if the key is not present in the B-tree map.

pub fn get_seal<'a, Q>( this: Seal<'a, ArchivedBTreeMap<K, V, E>>, key: &Q, ) -> Option<Seal<'a, V>>

where Q: Ord + ?Sized, K: Borrow<Q> + Ord,

Returns the mutable value associated with the given key, or None if the key is not present in the B-tree map.

pub fn is_empty(&self) -> bool

Returns true if the B-tree map contains no entries.

pub fn len(&self) -> usize

Returns the number of entries in the B-tree map.

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

where Q: Ord + ?Sized, K: Borrow<Q> + Ord,

Gets the key-value pair associated with the given key, or None if the key is not present in the B-tree map.

pub fn get_key_value_seal<'a, Q>( this: Seal<'a, ArchivedBTreeMap<K, V, E>>, key: &Q, ) -> Option<(&'a K, Seal<'a, V>)>

where Q: Ord + ?Sized, K: Borrow<Q> + Ord,

Gets the mutable key-value pair associated with the given key, or None if the key is not present in the B-tree map.

pub fn resolve_from_len( len: usize, resolver: BTreeMapResolver, out: Place<ArchivedBTreeMap<K, V, E>>, )

Resolves an ArchivedBTreeMap from the given length, resolver, and output place.

pub fn serialize_from_ordered_iter<I, BKU, BVU, KU, VU, S>( iter: I, serializer: &mut S, ) -> Result<BTreeMapResolver, <S as Fallible>::Error>

where I: ExactSizeIterator<Item = (BKU, BVU)>, BKU: Borrow<KU>, BVU: Borrow<VU>, KU: Serialize<S, Archived = K>, VU: Serialize<S, Archived = V>, S: Fallible + Allocator + Writer + ?Sized, <S as Fallible>::Error: Source,

Serializes an ArchivedBTreeMap from the given iterator and serializer.

pub fn visit<T>(&self, f: impl FnMut(&K, &V) -> ControlFlow<T>) -> Option<T>

Visits every key-value pair in the B-tree with a function.

If f returns ControlFlow::Break, visit will return Some with the broken value. If f returns Continue for every pair in the tree, visit will return None.

pub fn visit_seal<T>( this: Seal<'_, ArchivedBTreeMap<K, V, E>>, f: impl FnMut(&K, Seal<'_, V>) -> ControlFlow<T>, ) -> Option<T>

Visits every mutable key-value pair in the B-tree with a function.

If f returns ControlFlow::Break, visit will return Some with the broken value. If f returns Continue for every pair in the tree, visit will return None.

Trait Implementations

impl<K, V, const E: usize, __C> CheckBytes<__C> for ArchivedBTreeMap<K, V, E>

where __C: Fallible + ?Sized, <__C as Fallible>::Error: Trace, ArchivedBTreeMap<K, V, E>: Verify<__C>, RelPtr<Node<K, V, E>, i32_le>: CheckBytes<__C>, u32_le: CheckBytes<__C>, PhantomData<(K, V)>: CheckBytes<__C>,

unsafe fn check_bytes( value: *const ArchivedBTreeMap<K, V, E>, context: &mut __C, ) -> Result<(), <__C as Fallible>::Error>

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

impl<K, V, const E: usize> Debug for ArchivedBTreeMap<K, V, E>

where K: Debug, V: Debug,

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

Formats the value using the given formatter.

impl<K, V, D> Deserialize<BTreeMap<K, V>, D> for ArchivedBTreeMap<<K as Archive>::Archived, <V as Archive>::Archived>

where K: Archive + Ord, <K as Archive>::Archived: Deserialize<K, D> + Ord, V: Archive, <V as Archive>::Archived: Deserialize<V, D>, D: Fallible + ?Sized,

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

Deserializes using the given deserializer

impl<A, B, K, V, D> DeserializeWith<ArchivedBTreeMap<<A as ArchiveWith<K>>::Archived, <B as ArchiveWith<V>>::Archived>, BTreeMap<K, V>, D> for MapKV<A, B>

where A: ArchiveWith<K> + DeserializeWith<<A as ArchiveWith<K>>::Archived, K, D>, B: ArchiveWith<V> + DeserializeWith<<B as ArchiveWith<V>>::Archived, V, D>, K: Ord, D: Fallible + ?Sized,

fn deserialize_with( field: &ArchivedBTreeMap<<A as ArchiveWith<K>>::Archived, <B as ArchiveWith<V>>::Archived>, deserializer: &mut D, ) -> Result<BTreeMap<K, V>, <D as Fallible>::Error>

Deserializes the field type F using the given deserializer.

impl<K, V, Q, const E: usize> Index<&Q> for ArchivedBTreeMap<K, V, E>

where Q: Ord + ?Sized, K: Borrow<Q> + Ord,

type Output = V

The returned type after indexing.

fn index(&self, key: &Q) -> &<ArchivedBTreeMap<K, V, E> as Index<&Q>>::Output

Performs the indexing (container[index]) operation.

impl<K, V, const E1: usize, const E2: usize> PartialEq<ArchivedBTreeMap<K, V, E2>> for ArchivedBTreeMap<K, V, E1>

where K: PartialEq, V: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

where AK: PartialEq<K>, AV: PartialEq<V>,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<C, K, V, const E: usize> Verify<C> for ArchivedBTreeMap<K, V, E>

where C: Fallible + ArchiveContext + ?Sized, <C as Fallible>::Error: Source, K: CheckBytes<C>, V: CheckBytes<C>,

fn verify(&self, context: &mut C) -> Result<(), <C as Fallible>::Error>

Checks whether the invariants of this type are upheld by self.

impl<K, V, const E: usize> Eq for ArchivedBTreeMap<K, V, E>

where K: PartialEq, V: PartialEq,

impl<K, V, const E: usize> Portable for ArchivedBTreeMap<K, V, E>

where RelPtr<Node<K, V, E>, i32_le>: Portable, u32_le: Portable, PhantomData<(K, V)>: Portable,