Struct bonsaidb::core::schema::Schematic

pub struct Schematic {
    pub name: SchemaName,
    /* private fields */
}

A collection of defined collections and views.

Fields

name: SchemaName

The name of the schema this was built from.

Implementations

impl Schematic

pub fn from_schema<S>() -> Result<Schematic, Error>where S: Schema + ?Sized,

Returns an initialized version from S.

pub fn define_collection<C>(&mut self) -> Result<(), Error>where C: Collection + 'static,

Adds the collection C and its views.

pub fn define_view<V>(&mut self, view: V) -> Result<(), Error>where V: MapReduce<View = V> + ViewSchema + SerializedView + Clone + 'static,

Adds the view V.

pub fn define_view_with_schema<V, S>( &mut self, view: V, schema: S ) -> Result<(), Error>where V: SerializedView + 'static, S: MapReduce<View = V> + ViewSchema + 'static,

Adds the view V.

pub fn contains_collection<C>(&self) -> boolwhere C: Collection + 'static,

Returns true if this schema contains the collection C.

pub fn collection_primary_key_description<'a>( &'a self, collection: &CollectionName ) -> Option<&'a KeyDescription>

Returns the description of the primary keyof the collection with the given name, or None if the collection can’t be found.

pub fn next_id_for_collection( &self, collection: &CollectionName, id: Option<DocumentId> ) -> Result<DocumentId, Error>

Returns the next id in sequence for the collection, if the primary key type supports the operation and the next id would not overflow.

pub fn view_by_name(&self, name: &ViewName) -> Result<&dyn Serialized, Error>

Looks up a view::Serialized by name.

pub fn view<V>(&self) -> Result<&dyn Serialized, Error>where V: View + 'static,

Looks up a view::Serialized through the the type V.

pub fn views(&self) -> impl Iterator<Item = &dyn Serialized>

Iterates over all registered views.

pub fn views_in_collection( &self, collection: &CollectionName ) -> impl Iterator<Item = &dyn Serialized>

Iterates over all views that belong to collection.

pub fn eager_views_in_collection( &self, collection: &CollectionName ) -> impl Iterator<Item = &dyn Serialized>

Iterates over all views that are eagerly updated that belong to collection.

pub fn encryption_key_for_collection( &self, collection: &CollectionName ) -> Option<&KeyId>

Returns a collection’s default encryption key, if one was defined.

pub fn collections(&self) -> impl Iterator<Item = &CollectionName>

Returns a list of all collections contained in this schematic.

Trait Implementations

impl Debug for Schematic

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

Formats the value using the given formatter.

impl<'a> From<&'a Schematic> for SchemaSummary

fn from(schematic: &'a Schematic) -> SchemaSummary

Converts to this type from the input type.