Struct bonsaidb::core::schema::Schematic

source ·
pub struct Schematic {
    pub name: SchemaName,
    /* private fields */
}
Expand description

A collection of defined collections and views.

Fields§

§name: SchemaName

The name of the schema this was built from.

Implementations§

source§

impl Schematic

source

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

Returns an initialized version from S.

source

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

Adds the collection C and its views.

source

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

Adds the view V.

source

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.

source

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

Returns true if this schema contains the collection C.

source

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.

source

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.

source

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

Looks up a view::Serialized by name.

source

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

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

source

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

Iterates over all registered views.

source

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

Iterates over all views that belong to collection.

source

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.

source

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

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

source

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

Returns a list of all collections contained in this schematic.

Trait Implementations§

source§

impl Debug for Schematic

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self, E>

source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more