Struct bonsaidb::core::schema::view::map::MappedDocuments

pub struct MappedDocuments<D, V>
where
    V: View,
{
    pub mappings: Vec<CollectionMap<<<V as View>::Collection as Collection>::PrimaryKey, <V as View>::Key, <V as View>::Value>>,
    pub documents: BTreeMap<<<V as View>::Collection as Collection>::PrimaryKey, D>,
}

A collection of mappings and the associated documents.

Fields

mappings: Vec<CollectionMap<<<V as View>::Collection as Collection>::PrimaryKey, <V as View>::Key, <V as View>::Value>>

The collection of mappings.

documents: BTreeMap<<<V as View>::Collection as Collection>::PrimaryKey, D>

All associated documents by ID.

Documents can appear in a mapping query multiple times. As a result, they are stored separately to avoid duplication.

Implementations

impl<D, V> MappedDocuments<D, V>

where V: View,

pub fn len(&self) -> usize

The number of mappings contained in this collection.

pub fn is_empty(&self) -> bool

Returns true if there are no mappings in this collection.

pub fn get( &self, index: usize ) -> Option<MappedDocument<'_, D, <V as View>::Key, <V as View>::Value>>

Returns the mapped document atindex, or None if index >= self.len().

pub const fn iter(&self) -> MappedDocumentsIter<'_, D, V>

Returns an iterator over the contained mapped documents.

Trait Implementations

impl<D, V> Debug for MappedDocuments<D, V>

where V: View, <V as View>::Key: Debug, <V as View>::Value: Debug, D: Debug, <<V as View>::Collection as Collection>::PrimaryKey: Debug,

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

Formats the value using the given formatter.

impl<'a, D, V> IntoIterator for &'a MappedDocuments<D, V>

where V: View,

type IntoIter = MappedDocumentsIter<'a, D, V>

Which kind of iterator are we turning this into?

type Item = MappedDocument<'a, D, <V as View>::Key, <V as View>::Value>

The type of the elements being iterated over.

fn into_iter(self) -> <&'a MappedDocuments<D, V> as IntoIterator>::IntoIter

Creates an iterator from a value.