Struct bonsaidb::core::schema::Schematic

pub struct Schematic {
    pub name: SchemaName,
    // some fields omitted
}

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: 'static + Collection, 

Adds the collection C and its views.

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

Adds the view V.

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

Adds the view V.

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

Returns true if this schema contains the collection C.

pub fn contains_collection_name(&self, collection: &CollectionName) -> bool

Returns true if this schema contains the collection C.

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: 'static + View, 

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
) -> Option<Vec<&dyn Serialized, Global>>

Iterates over all views that belong to collection.

pub fn unique_views_in_collection(
    &self,
    collection: &CollectionName
) -> Option<Vec<&dyn Serialized, Global>>

Iterates over all views that are unique 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) -> Vec<CollectionName, Global>

Returns a list of all collections contained in this schematic.

Trait Implementations

impl Debug for Schematic

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

Formats the value using the given formatter.