Struct Field 

pub struct Field {
    pub id: FieldId,
    pub name: FieldName,
    pub ty: FieldTy,
    pub nullable: bool,
    pub primary_key: bool,
    pub auto: Option<AutoStrategy>,
    pub constraints: Vec<Constraint>,
    pub variant: Option<VariantId>,
}

A single field within a model.

Fields are the building blocks of a model’s data structure. Each field has a unique FieldId, a name, a type (primitive, embedded, or relation), and metadata such as nullability, primary-key membership, auto-population strategy, and validation constraints.

Examples

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

let schema: Schema = /* ... */;
let model = schema.model(model_id).as_root_unwrap();
for field in &model.fields {
    println!("{}: primary_key={}", field.name, field.primary_key);
}

Fields

id: FieldId

Uniquely identifies this field within its containing model.

name: FieldName

The field’s application and storage names.

ty: FieldTy

The field’s type: primitive, embedded, or a relation variant.

nullable: bool

true if this field accepts None / NULL values.

primary_key: bool

true if this field is part of the model’s primary key.

auto: Option<AutoStrategy>

If set, Toasty automatically populates this field on insert.

constraints: Vec<Constraint>

Validation constraints applied to this field’s values.

variant: Option<VariantId>

If this field belongs to an enum variant, identifies that variant. None for fields on root models and embedded structs.

Implementations

impl Field

pub fn id(&self) -> FieldId

Returns this field’s FieldId.

pub fn name(&self) -> &FieldName

Returns a reference to this field’s FieldName.

pub fn ty(&self) -> &FieldTy

Returns a reference to this field’s FieldTy.

pub fn nullable(&self) -> bool

Returns true if this field is nullable.

pub fn primary_key(&self) -> bool

Returns true if this field is part of the primary key.

pub fn auto(&self) -> Option<&AutoStrategy>

Returns the auto-population strategy, if one is configured.

pub fn is_auto_increment(&self) -> bool

Returns true if this field uses auto-increment for value generation.

pub fn is_relation(&self) -> bool

Returns true if this field is a relation (BelongsTo, HasMany, or HasOne).

pub fn full_name(&self, schema: &Schema) -> Option<String>

Returns a fully qualified name for the field.

pub fn relation_target_id(&self) -> Option<ModelId>

If the field is a relation, return the relation’s target ModelId.

pub fn relation_target<'a>(&self, schema: &'a Schema) -> Option<&'a Model>

If the field is a relation, return the target of the relation.

pub fn expr_ty(&self) -> &Type

Returns the expression type this field evaluates to.

For primitives this is the scalar type; for relations and embedded types it is the type visible to the application layer.

pub fn pair(&self) -> Option<FieldId>

Returns the paired relation field, if this field is a relation.

For BelongsTo this returns the inverse HasMany/HasOne (if linked). For HasMany and HasOne this returns the paired BelongsTo. Returns None for primitive and embedded fields.

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.

impl From<&Field> for FieldId

fn from(val: &Field) -> Self

Converts to this type from the input type.

impl From<&Field> for Projection

fn from(value: &Field) -> Self

Converts to this type from the input type.