Struct ejdb::meta::DatabaseMetadata

pub struct DatabaseMetadata(_);

Represents metainformation about an EJDB database.

EJDB returns metadata in form of a BSON document, therefore this struct is just a wrapper around a BSON document value. Due to Deref implementation, it is possible to call bson::Document methods on this structure directly.

Note that EJDB metadata has fixed form, therefore every method which provides access to the parts of metadata will panic if it can't obtain this part or if the actual BSON value is of different type. If this happens, then it is a bug in this library.

Methods

impl DatabaseMetadata

pub fn into_inner(self) -> Document

Consumes the metadata object, returning the underlying BSON document.

pub fn file(&self) -> &str

Returns the file name of the main database file.

pub fn collections(&self) -> Collections

Returns an iterator of metadata for each collection in the database.

Trait Implementations

impl PartialEq<DatabaseMetadata> for DatabaseMetadata

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

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

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

This method tests for !=.

impl Clone for DatabaseMetadata

fn clone(&self) -> DatabaseMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DatabaseMetadata

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

Formats the value using the given formatter.

impl Deref for DatabaseMetadata

type Target = Document

The resulting type after dereferencing.

fn deref(&self) -> &Document

Dereferences the value.