Struct ModelSchema 

#[non_exhaustive]
pub struct ModelSchema {
    pub table: &'static str,
    pub columns: &'static [ModelColumn],
    pub primary_key: &'static str,
    pub search_index: Option<&'static str>,
}

The full schema contract for one model.

Generated by #[derive(RustioModel)] in commit 2 and exposed via rustio_core::contract::HasSchema (also commit 2). The validator in commit 3 consumes a &'static ModelSchema and produces a SchemaReport.

Lives entirely in static memory. Cloning copies the slice fat pointer, not the contents.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

table: &'static str

SQL table name. Conventionally plural snake_case (projects, invoices).

columns: &'static [ModelColumn]

All columns in declaration order. Validator uses this both for forward checks (every Rust column must be in PG) and reverse checks (every PG column not in Rust → warning).

primary_key: &'static str

Name of the primary-key column. Conventionally "id". Must match exactly one entry in columns with primary_key: true.

search_index: Option<&'static str>

Meili index name when the model is searchable, None when it isn’t. Conventionally equal to table.

Implementations

impl ModelSchema

pub const fn new( table: &'static str, columns: &'static [ModelColumn], primary_key: &'static str, ) -> Self

Construct a schema from its required parts. search_index defaults to None; opt in via Self::with_search_index.

const fn so the macro can emit static SCHEMA: ModelSchema = ModelSchema::new(...) directly, and so external code (tests, examples) can construct schemas despite the #[non_exhaustive] attribute.

static COLS: &[ModelColumn] = &[
    ModelColumn::new("id", "BIGSERIAL PRIMARY KEY", RustType::I64).primary_key(),
];
const POSTS: ModelSchema = ModelSchema::new("posts", COLS, "id");

pub const fn with_search_index(self, index: &'static str) -> Self

Set the Meili index name. Conventionally equal to table. Setting this signals the model is searchable; the search pipeline in commit 6 keys off this field.

pub fn column(&self, name: &str) -> Option<&ModelColumn>

Find a column by name. O(n) linear scan — column counts are small (typically < 20 per model) and this is not on a hot path.

pub fn searchable_columns(&self) -> impl Iterator<Item = &ModelColumn>

All columns flagged as searchable. The macro layer in commit 2 guarantees these are all RustType::String.

Trait Implementations

impl Clone for ModelSchema

fn clone(&self) -> ModelSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelSchema

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

Formats the value using the given formatter.