Struct ColumnDef

#[non_exhaustive]
pub struct ColumnDef {
    pub name: Identifier,
    pub col_id: ColId,
    pub ty: AlgebraicType,
    pub ty_for_generate: AlgebraicTypeUse,
    pub table_name: Identifier,
}

A struct representing the validated definition of a database column.

Cannot be created directly. Construct a ModuleDef by validating a RawModuleDef instead, and then access the column from there.

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.

name: Identifier

The name of the column. Unique within the containing TableDef, but NOT within the containing ModuleDef.

col_id: ColId

The ID of this column.

ty: AlgebraicType

The type of this column. May refer to the containing ModuleDef’s Typespace. Must satisfy AlgebraicType::is_valid_for_client_type_use.

Will always correspond to the corresponding element of this table’s product_type_ref, that is, the element at index col_id.idx() with name Some(name.as_str()).

ty_for_generate: AlgebraicTypeUse

The type of the column, formatted for client code generation.

table_name: Identifier

The table this ColumnDef is stored in.

Trait Implementations

impl Clone for ColumnDef

fn clone(&self) -> ColumnDef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnDef

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

Formats the value using the given formatter.

impl ModuleDefLookup for ColumnDef

type Key<'a> = (&'a Identifier, &'a Identifier)

A reference to a definition of this type within a module def. This reference should be portable across migrations.

fn key(&self) -> Self::Key<'_>

Get a reference to this definition.

fn lookup<'a>( module_def: &'a ModuleDef, (table_name, name): Self::Key<'_>, ) -> Option<&'a Self>

Look up this entity in the module def.

impl PartialEq for ColumnDef

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

impl StructuralPartialEq for ColumnDef