Struct rkyv::collections::index_set::ArchivedIndexSet

pub struct ArchivedIndexSet<K> { /* private fields */ }

An archived IndexSet.

Implementations

impl<K> ArchivedIndexSet<K>

pub fn contains<Q>(&self, k: &Q) -> bool

where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

Returns whether a key is present in the hash set.

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

Returns the first key.

pub fn get<Q>(&self, k: &Q) -> Option<&K>

where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

Returns the value stored in the set, if any.

pub fn get_full<Q>(&self, k: &Q) -> Option<(usize, &K)>

where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

Returns the item index and value stored in the set, if any.

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

Gets a key by index.

pub fn get_index_of<Q>(&self, key: &Q) -> Option<usize>

where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

Returns the index of a key if it exists in the set.

pub fn hasher(&self) -> HashBuilder

Gets the hasher for this index set.

pub fn is_empty(&self) -> bool

Returns whether the index set contains no values.

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

Returns an iterator over the keys of the index set in order.

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

Returns the last key.

pub fn len(&self) -> usize

Returns the number of elements in the index set.

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

Resolves an archived index map from a given length and parameters.

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 hash map

impl<K> ArchivedIndexSet<K>

pub unsafe fn serialize_from_iter_index<'a, UK, I, F, S>( iter: I, index: F, serializer: &mut S ) -> Result<IndexSetResolver, S::Error>

where UK: 'a + Hash + Eq + Serialize<S, Archived = K>, I: Clone + ExactSizeIterator<Item = &'a UK>, F: Fn(&UK) -> usize, S: ScratchSpace + Serializer + ?Sized,

Serializes an iterator of keys as an index set.

Safety

• The keys returned by the iterator must be unique
• The index function must return the index of the given key within the iterator

Trait Implementations

impl<__C: ?Sized, K> CheckBytes<__C> for ArchivedIndexSet<K>

where ArchivedIndexMap<K, ()>: CheckBytes<__C>,

type Error = StructCheckError

The error that may result from checking the type.

unsafe fn check_bytes<'__bytecheck>( value: *const Self, context: &mut __C ) -> Result<&'__bytecheck Self, StructCheckError>

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

impl<K: Debug> Debug for ArchivedIndexSet<K>

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

Formats the value using the given formatter.

impl<K: PartialEq> PartialEq for ArchivedIndexSet<K>

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.