Enum Model 

pub enum Model {
    Root(ModelRoot),
    EmbeddedStruct(EmbeddedStruct),
    EmbeddedEnum(EmbeddedEnum),
}

A model in the application schema.

Models come in three flavors:

• Model::Root – a top-level model backed by its own database table.
• Model::EmbeddedStruct – a struct whose fields are flattened into a parent model’s table.
• Model::EmbeddedEnum – an enum stored via a discriminant column plus optional per-variant data columns in the parent table.

Examples

use toasty_core::schema::app::{Model, Schema};

let schema: Schema = /* built from derive macros */;
for model in schema.models() {
    if model.is_root() {
        println!("Root model: {}", model.name().upper_camel_case());
    }
}

Variants

Root(ModelRoot)

A root model that maps to its own database table and can be queried directly.

EmbeddedStruct(EmbeddedStruct)

An embedded struct whose fields are flattened into its parent model’s table.

EmbeddedEnum(EmbeddedEnum)

An embedded enum stored as a discriminant column (plus optional per-variant data columns) in the parent table.

Implementations

impl Model

pub fn id(&self) -> ModelId

Returns this model’s ModelId.

pub fn name(&self) -> &Name

Returns a reference to this model’s Name.

pub fn is_root(&self) -> bool

Returns true if this is a root model (has a table and primary key)

pub fn is_embedded(&self) -> bool

Returns true if this is an embedded model (flattened into parent)

pub fn can_be_relation_target(&self) -> bool

Returns true if this model can be the target of a relation

pub fn as_root(&self) -> Option<&ModelRoot>

Returns the inner ModelRoot if this is a root model.

pub fn as_root_unwrap(&self) -> &ModelRoot

Returns a reference to the root model data.

Panics

Panics if this is not a Model::Root.

pub fn as_root_mut_unwrap(&mut self) -> &mut ModelRoot

Returns a mutable reference to the root model data.

Panics

Panics if this is not a Model::Root.

pub fn as_embedded_struct_unwrap(&self) -> &EmbeddedStruct

Returns a reference to the embedded struct data.

Panics

Panics if this is not a Model::EmbeddedStruct.

pub fn as_embedded_enum_unwrap(&self) -> &EmbeddedEnum

Returns a reference to the embedded enum data.

Panics

Panics if this is not a Model::EmbeddedEnum.

Trait Implementations

impl Clone for Model

fn clone(&self) -> Model

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Model

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

Formats the value using the given formatter.

impl From<&Model> for ModelId

fn from(value: &Model) -> Self

Converts to this type from the input type.