Schema

Struct Schema 

Source
pub struct Schema {
    pub app: Schema,
    pub db: Schema,
    pub mapping: Mapping,
}
Expand description

The combined schema: app-level models, database-level tables, and the mapping that connects them.

Constructed with Builder and validated on creation. Immutable at runtime.

§Examples

use toasty_core::Schema;

fn inspect(schema: &Schema) {
    for (id, model) in &schema.app.models {
        let table = schema.table_for(*id);
        println!("{} -> {}", model.name().snake_case(), table.name);
    }
}

Fields§

§app: Schema

Application-level schema.

§db: Schema

Database-level schema.

§mapping: Mapping

Maps the app-level schema to the db-level schema.

Implementations§

Source§

impl Schema

Source

pub fn builder() -> Builder

Returns a new Builder for constructing a Schema.

§Examples
use toasty_core::Schema;

let builder = Schema::builder();
Source

pub fn mapping_for(&self, id: impl Into<ModelId>) -> &Model

Returns the mapping for the given model.

§Panics

Panics if id does not correspond to a model in the schema.

§Examples
use toasty_core::Schema;

let mapping = schema.mapping_for(model_id);
println!("table: {:?}", mapping.table);
Source

pub fn table_for(&self, id: impl Into<ModelId>) -> &Table

Returns the database table that stores the given model.

§Panics

Panics if id does not correspond to a model in the schema.

§Examples
let table = schema.table_for(model_id);
println!("table name: {}", table.name);
Source

pub fn table_id_for(&self, id: impl Into<ModelId>) -> TableId

Returns the TableId for the table that stores the given model.

§Panics

Panics if id does not correspond to a model in the schema.

Trait Implementations§

Source§

impl Debug for Schema

Source§

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

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

impl Resolve for Schema

Source§

fn model(&self, id: ModelId) -> Option<&Model>

Returns a reference to the application Model with the specified ID. Read more
Source§

fn table(&self, id: TableId) -> Option<&Table>

Returns a reference to the database Table with the specified ID. Read more
Source§

fn table_for_model(&self, model: &ModelRoot) -> Option<&Table>

Returns the database table that stores the given model, if any.

Auto Trait Implementations§

§

impl Freeze for Schema

§

impl RefUnwindSafe for Schema

§

impl Send for Schema

§

impl Sync for Schema

§

impl Unpin for Schema

§

impl UnwindSafe for Schema

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

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

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

Source§

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.