Struct pliantdb_core::schema::Schematic

pub struct Schematic { /* fields omitted */ }

A collection of defined collections and views.

Implementations

impl Schematic

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

Adds the collection C and its views.

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

Adds the view V.

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

Returns true if this schema contains the collection C.

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

Returns true if this schema contains the collection C.

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

Looks up a view::Serialized by name.

pub fn view<V: View + 'static>(&self) -> Option<&dyn Serialized>

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>>

Iterates over all views that belong to collection.

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

Iterates over all views that are unique that belong to collection.

Trait Implementations

impl Debug for Schematic

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

Formats the value using the given formatter.

impl Default for Schematic

fn default() -> Schematic

Returns the “default value” for a type.