Struct Field 

pub struct Field {
    pub ty: FieldType,
    pub references: Option<String>,
    pub required: bool,
    pub unique: bool,
    pub hidden: bool,
    pub default: Option<Value>,
    pub max_length: Option<u32>,
    pub case: Option<TextCase>,
    pub on_delete: Option<OnDelete>,
    pub admin: FieldAdmin,
}

One column in a resource.

Fields

ty: FieldType

references: Option<String>

Target resource name when ty == Reference.

required: bool

unique: bool

hidden: bool

Exclude from API responses (e.g. password hashes).

default: Option<Value>

Optional default rendered as a SQL literal.

max_length: Option<u32>

case: Option<TextCase>

Force a text field to one case, in storage and in every response.

For values that are codes rather than prose — a currency, a country, a ticket prefix, a coupon. Those have a conventional case, and the difference between eur and EUR is a spelling rather than a distinction: left alone it produces two of everything, and a filter that matches whichever one the caller happened to type.

Only meaningful on string and text; ignored elsewhere, because there is no case to change about a number.

on_delete: Option<OnDelete>

For reference fields: what happens to this row when the referenced row is deleted. Defaults to OnDelete::Restrict (safe: blocks orphaning).

admin: FieldAdmin

Dashboard presentation for this field, from [fields.<name>.admin].

Implementations

impl Field

pub fn text_case(&self) -> Option<TextCase>

The case to force on this field’s value, if any.

None for every non-text field whatever the TOML said: case on a number is a line that reads as if it does something, and quietly ignoring it here is better than upper-casing the digits of a price.

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<'de> Deserialize<'de> for Field

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.