Struct ExtensibleFieldDef 

pub struct ExtensibleFieldDef {
    pub key: String,
    pub type_: String,
    pub required: bool,
    pub filterable: bool,
    pub sortable: bool,
    pub allowed: Option<Vec<Value>>,
    pub min: Option<f64>,
    pub max: Option<f64>,
    pub max_length: Option<u32>,
    pub min_length: Option<u32>,
    pub pattern: Option<String>,
}

One extensible-field definition: its key, declared type, and validation/query flags.

Fields

key: String

Inner JSON key (camelCase by convention).

type_: String

Declared canonical type string (e.g. "int", "decimal", "text", "boolean"). Drives the SQL cast used for type-correct comparison/sorting.

required: bool

Whether this field must be present on create.

filterable: bool

Whether this field may be used in RSQL q= filters. Defaults to true.

sortable: bool

Whether this field may be used in sort=. Defaults to true.

allowed: Option<Vec<Value>>

Allowed value set (enum-style).

min: Option<f64>

Numeric lower bound (inclusive).

max: Option<f64>

Numeric upper bound (inclusive).

max_length: Option<u32>

Maximum string length.

min_length: Option<u32>

Minimum string length.

pattern: Option<String>

Regex the string value must fully match.

Implementations

impl ExtensibleFieldDef

pub fn canonical(&self) -> CanonicalType

Resolve the declared type string to a CanonicalType.

Trait Implementations

impl Clone for ExtensibleFieldDef

fn clone(&self) -> ExtensibleFieldDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExtensibleFieldDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExtensibleFieldDef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.