Struct ejdb::meta::CollectionMetadata

pub struct CollectionMetadata<'a>(_);

Represents metainformation about a collection in an EJDB database.

This structure only provides a view into the original BSON document, therefore it has a lifetime dependency on the database metadata structure. It is also not possible to unwrap the inner document, though it still has a Deref implementation with bson::Document as a target.

Methods

impl<'a> CollectionMetadata<'a>

pub fn name(&self) -> &str

Returns the name of this collection.

pub fn file(&self) -> &str

Returns the file path of this collection.

pub fn records(&self) -> u64

Returns the number of records in this collection.

pub fn buckets(&self) -> u64

Returns the number of buckets in this collection.

pub fn cached_records(&self) -> u64

Returns the number of cached records for this collection.

pub fn large(&self) -> bool

Returns true if the collection can hold more than 2GB of data, false otherwise.

pub fn compressed(&self) -> bool

Returns true if DEFLATE compression is applied to this collection's records, false otherwise.

pub fn indices(&self) -> CollectionIndices

Returns an iterator of metadata of indices in this collection.

Trait Implementations

impl<'a> PartialEq<CollectionMetadata<'a>> for CollectionMetadata<'a>

fn eq(&self, other: &CollectionMetadata<'a>) -> bool

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

fn ne(&self, other: &CollectionMetadata<'a>) -> bool

This method tests for !=.

impl<'a> Clone for CollectionMetadata<'a>

fn clone(&self) -> CollectionMetadata<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for CollectionMetadata<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for CollectionMetadata<'a>

type Target = Document

The resulting type after dereferencing.

fn deref(&self) -> &Document

Dereferences the value.