Struct FieldSchema 

pub struct FieldSchema {

    pub field_type: FieldType,
    pub primary: bool,
    pub generated: bool,
    pub required: bool,
    pub unique: bool,
    pub nullable: bool,
    pub reference: Option<String>,
    pub min: Option<Value>,
    pub max: Option<Value>,
    pub format: Option<String>,
    pub values: Option<Vec<String>>,
    pub default: Option<Value>,
    pub sensitive: bool,
    pub search: bool,
    pub items: Option<ItemsSpec>,
    pub transient: bool,
}

Definition of a single field in a resource schema.

Matches the inline YAML format:

email: { type: string, format: email, unique: true, required: true }

Fields

field_type: FieldType

The data type of this field.

primary: bool

Whether this field is the primary key.

generated: bool

Whether this field is auto-generated (e.g., uuid v4, timestamps).

required: bool

Whether this field is required (NOT NULL + validated on input).

unique: bool

Whether this field has a unique constraint.

nullable: bool

Whether this field is explicitly nullable.

reference: Option<String>

Foreign key reference in resource.field format.

min: Option<Value>

Minimum value (number) or length (string).

max: Option<Value>

Maximum value (number) or length (string).

format: Option<String>

String format validation (email, url, uuid).

values: Option<Vec<String>>

Allowed values for enum-type fields.

default: Option<Value>

Default value for this field.

sensitive: bool

Whether this field contains sensitive data (redacted in logs).

search: bool

Whether this field is included in full-text search.

items: Option<ItemsSpec>

Element type for array fields.

transient: bool

Input-only field: validated and exposed to the before-controller in ctx.input, but never persisted (no migration column, no SQL reference) and never returned in API responses. Stripped from ctx.input after the before-controller runs.

Implementations

impl FieldSchema

pub fn is_persisted(&self) -> bool

Returns true if this field is stored in the database. Transient fields exist only at the API boundary and are never persisted.

Trait Implementations

impl Clone for FieldSchema

fn clone(&self) -> FieldSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FieldSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FieldSchema

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FieldSchema

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 FieldSchema