Struct Field 

pub struct Field {
    pub name: String,
    pub ty: Ty,
    pub required: bool,
    pub flexible: bool,
    pub default: Option<String>,
    pub description: Option<String>,
    pub constraints: Constraints,
}

A field of a TypeDef::Struct, a Record / Relation, or of a protocol-dialect payload (Request / Event / Message).

Fields

name: String

Field name.

ty: Ty

Field type.

required: bool

Whether the field is required. false maps to the target’s optional form (Rust Option<T>, TS ?:, Zod .optional(), SurrealQL option<T>).

flexible: bool

Whether an object-typed field is schemaless (flexible=#true). Only meaningful for Ty::Primitive(Prim::Json); emitted by the SurrealQL target as FLEXIBLE TYPE object.

default: Option<String>

An optional default value, as written in the KDL default="..." property. Carried verbatim; emitters quote / render it per target.

description: Option<String>

An optional documentation string, from the KDL description="..." property. Emitted as a doc comment (Rust ///, TS /** */ JSDoc, Zod .describe(...), SurrealQL COMMENT '...').

constraints: Constraints

Value constraints, from the KDL min / max / min_length / max_length / pattern properties. Emitted only by the Zod and SurrealQL targets — the Rust / TypeScript type system cannot express them.

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 PartialEq for Field

fn eq(&self, other: &Field) -> 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 Eq for Field

impl StructuralPartialEq for Field