Struct ColumnSpec 

#[non_exhaustive]
pub struct ColumnSpec<C = NoExtras> {
    pub col_type: Option<String>,
    pub flags: Vec<ColumnFlag>,
    pub references: Option<ReferenceSugar>,
    pub lazy: Option<String>,
    pub expr: Option<String>,
    pub driver: C,
}

Per-column metadata in a VistaSpec.

flags are snake_case names; a name vista doesn’t know is kept as ColumnFlag::Other for the layer that owns the YAML schema to accept or reject. references holds the sugar form (references: products) when the foreign key is the column itself; full reference declarations live in the parent VistaSpec::references map.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

col_type: Option<String>

flags: Vec<ColumnFlag>

references: Option<ReferenceSugar>

lazy: Option<String>

Rhai script for a lazy computed column. Runs in Rust on each returned record — the record as built so far is exposed as row, and the script’s final expression becomes this column’s value. Lazy columns apply in declaration order, so a later one sees the values earlier ones produced. Lowered via lazy_column onto a Vista computed column; never part of the backend query.

expr: Option<String>

Rhai script for a server-side computed column. Evaluated once at build time with the driver’s expression vocabulary (surreal::ident(...), operators, surreal::expr("raw"), …) into a query expression, then lowered via Table::with_expression — the backend projects it as (<expr>) AS <column>. Unlike lazy: it participates in the query, so it can traverse record links or call backend functions. Computed columns are read-only.

driver: C

Implementations

impl<C> ColumnSpec<C>

pub fn has_flag(&self, flag: impl Into<ColumnFlag>) -> bool

impl<C: Default> ColumnSpec<C>

pub fn new() -> Self

pub fn with_type(self, ty: impl Into<String>) -> Self

pub fn with_flag(self, flag: impl Into<ColumnFlag>) -> Self

pub fn with_lazy(self, script: impl Into<String>) -> Self

pub fn with_expr(self, script: impl Into<String>) -> Self

impl<C> ColumnSpec<C>

pub fn lazy_column(&self, name: &str) -> Result<Option<Column>>

The Vista column for a lazy: column — its type and flags, computed by its script (see Column::with_expression) — or None for a stored column. Errors when the script doesn’t compile, or when this crate was built without the rhai feature.

Trait Implementations

impl<C: Clone> Clone for ColumnSpec<C>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for ColumnSpec<C>

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

Formats the value using the given formatter.

impl<C: Default> Default for ColumnSpec<C>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, C> Deserialize<'de> for ColumnSpec<C>

where C: DeserializeOwned + Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C> Serialize for ColumnSpec<C>

where C: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.