Skip to main content

DefineField

Struct DefineField 

Source
pub struct DefineField {
    pub path: Spanned<Idiom>,
    pub table: Spanned<String>,
    pub ty: Option<Spanned<TypeExpr>>,
    pub overwrite: bool,
    pub default: Option<Spanned<Expr>>,
    pub value: Option<Spanned<Expr>>,
    pub computed: Option<Spanned<Expr>>,
    pub reference: bool,
    pub assert: Option<Spanned<Expr>>,
    pub readonly: bool,
    pub permissions: Vec<Spanned<Expr>>,
}
Expand description

DEFINE FIELD — a (possibly nested) field on a table, with its declared type.

Fields§

§path: Spanned<Idiom>

The (possibly nested) field path.

§table: Spanned<String>

The table the field belongs to.

§ty: Option<Spanned<TypeExpr>>

TYPE <type> — the declared field type, if any.

§overwrite: bool

OVERWRITE — redefine an existing field.

§default: Option<Spanned<Expr>>

DEFAULT <expr> — supplied when a row is created without the field.

§value: Option<Spanned<Expr>>

VALUE <expr> — the field is computed; writes are overwritten.

§computed: Option<Spanned<Expr>>

COMPUTED <expr> — the field is derived from an expression and never stored (SurrealDB 3.0). Like VALUE, its type is the expression’s; a common form is a record-reference back-traversal (COMPUTED <~team).

§reference: bool

REFERENCE — the field’s record<...> link participates in reference traversal (<~), so a back-reference on the target table can resolve through it.

§assert: Option<Spanned<Expr>>

ASSERT <expr> — must hold for every write ($value in scope).

§readonly: bool

READONLY — writable only at creation.

§permissions: Vec<Spanned<Expr>>

PERMISSIONS FOR <action> WHERE <expr> predicate expressions. Each WHERE predicate is retained so the analyzer can walk it against the row; NONE/FULL carry no predicate.

Trait Implementations§

Source§

impl Clone for DefineField

Source§

fn clone(&self) -> DefineField

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DefineField

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for DefineField

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DefineField

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.