Struct Module 

pub struct Module {
    pub name: String,
    pub model: Option<String>,
    pub fields: Vec<String>,
    pub belongs_to: Vec<Relation>,
}

One application module as recorded in gize.toml (ADR-009 revision).

name is the module/table name as used on disk (snake_case, e.g. users, products). model is the struct name, recorded only when it cannot be derived back from name (Movie -> movies would read back as Movy); see Module::model_name. fields reuse the CLI’s name:Type grammar verbatim (see crate::field) so the manifest and the command line share one definition of a model. belongs_to records the module’s 1-N relationships (ADR-014).

Fields

name: String

model: Option<String>

fields: Vec<String>

belongs_to: Vec<Relation>

Implementations

impl Module

pub fn named(name: impl Into<String>) -> Self

A module with just a name and no declared shape (used by gize make app, and when upgrading a legacy names-only manifest).

pub fn for_model(model: &ModelSpec) -> Self

The module recorded for model, as gize make crud writes it to the manifest. The struct name is stored only when deriving it from the table name would not give it back, so manifests of models that round-trip (Post -> posts) stay as they were.

pub fn model_name(&self) -> String

The model’s struct name: the recorded model, or else derived from the module/table name (posts -> Post), which is what manifests written before model existed rely on.

pub fn model_spec(&self) -> Result<ModelSpec>

Recover the model definition this module describes, for regenerating its code during gize sync (ADR-009 revision). The struct name comes from Module::model_name; the fields are re-parsed from their name:Type tokens.

Trait Implementations

impl Clone for Module

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Module

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

Formats the value using the given formatter.

impl Default for Module

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Module

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Module

impl PartialEq for Module

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Module

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Module