pub trait Model: Sized {
type PrimaryKey: PrimaryKey;
Show 19 methods
// Required methods
fn table_name() -> &'static str;
fn columns() -> &'static [&'static str];
fn primary_key() -> ModelField<Self, Self::PrimaryKey>;
fn primary_key_value(&self) -> Self::PrimaryKey;
fn schema() -> TableSchema;
fn from_row(row: &Row) -> Result<Self, DecodeError>;
fn insert_values(&self) -> Vec<InsertValue>;
// Provided methods
fn model_name() -> &'static str { ... }
fn from_row_at(row: &Row, offset: usize) -> Result<Self, DecodeError> { ... }
fn from_sqlite_row(row: &Row<'_>) -> Result<Self> { ... }
fn write_protected_columns() -> &'static [&'static str] { ... }
fn json_columns() -> &'static [&'static str] { ... }
fn field_values(&self) -> Vec<InsertValue> { ... }
fn managed_update_values() -> Vec<Assignment> { ... }
fn query() -> SelectQuery<Self> { ... }
fn insert() -> InsertQuery<Self> { ... }
fn update() -> UpdateQuery<Self> { ... }
fn delete() -> DeleteQuery<Self> { ... }
fn create_table() -> CreateTableQuery<Self> { ... }
}Expand description
Trait implemented by #[derive(Model)] for ORM models.
Required Associated Types§
type PrimaryKey: PrimaryKey
Required Methods§
fn table_name() -> &'static str
fn columns() -> &'static [&'static str]
Sourcefn primary_key() -> ModelField<Self, Self::PrimaryKey>
fn primary_key() -> ModelField<Self, Self::PrimaryKey>
Returns the model’s typed primary-key field.
fn primary_key_value(&self) -> Self::PrimaryKey
fn schema() -> TableSchema
fn from_row(row: &Row) -> Result<Self, DecodeError>
fn insert_values(&self) -> Vec<InsertValue>
Provided Methods§
Sourcefn model_name() -> &'static str
fn model_name() -> &'static str
Stable Rust model name used by migration state. It is deliberately
independent from table_name() so table renames keep model identity.
fn from_row_at(row: &Row, offset: usize) -> Result<Self, DecodeError>
Sourcefn from_sqlite_row(row: &Row<'_>) -> Result<Self>
fn from_sqlite_row(row: &Row<'_>) -> Result<Self>
Adapter for direct SQLite driver queries.
Sourcefn write_protected_columns() -> &'static [&'static str]
fn write_protected_columns() -> &'static [&'static str]
Physical columns that must not accept untrusted write values. The derive
includes ImageField and Option<ImageField>; trusted ORM writes remain
available for validated uploads. External write adapters enforce this
metadata, just as ModelSerializer enforces image read-only behavior.
Sourcefn json_columns() -> &'static [&'static str]
fn json_columns() -> &'static [&'static str]
TEXT-backed JSON columns retain their JSON type in external codecs.
Sourcefn field_values(&self) -> Vec<InsertValue>
fn field_values(&self) -> Vec<InsertValue>
Materialized field values keyed by physical SQL column, independently of Serde naming. Unlike insert values, these include generated keys and managed timestamps. The derive generates a complete implementation; manual models with managed fields should override this method.
fn managed_update_values() -> Vec<Assignment>
fn query() -> SelectQuery<Self>
fn insert() -> InsertQuery<Self>
fn update() -> UpdateQuery<Self>
fn delete() -> DeleteQuery<Self>
fn create_table() -> CreateTableQuery<Self>
Dyn Compatibility§
This trait is not dyn compatible.
In older versions of Rust, dyn compatibility was called "object safety".