Struct ColumnMetadata

pub struct ColumnMetadata {
    pub column_name: String,
    pub column_type: TType,
    pub marked_primary_key: bool,
    pub has_database_default: bool,
    pub identifier: Ident,
    pub many_to_one_column_name: Option<String>,
    pub many_to_many_table: Option<String>,
    pub one_to_many_foreign_key: Option<ForeignKey>,
    pub skip: bool,
    pub experimental_encode_as_json: bool,
    pub rust_default: Option<String>,
}

All the metadata we can capture about a column

Fields

column_name: String

Name of the column in the database

column_type: TType

marked_primary_key: bool

Only says whether the primary key is marked (with an attribute). Use table_metadata.primary_key to definitively know the primary key.

has_database_default: bool

identifier: Ident

Identifier used in Rust to refer to the column

many_to_one_column_name: Option<String>

many_to_many_table: Option<String>

one_to_many_foreign_key: Option<ForeignKey>

skip: bool

experimental_encode_as_json: bool

rust_default: Option<String>

Implementations

impl ColumnMetadata

pub fn is_default(&self) -> bool

impl ColumnMetadata

pub fn new(name: &str, ty: &str) -> Self

pub fn new_join(name: &str, join_model: &str) -> Self

pub fn builder() -> ColumnMetadataBuilder

pub fn is_join(&self) -> bool

pub fn is_join_many(&self) -> bool

pub fn is_json(&self) -> bool

pub fn joined_struct_name(&self) -> Option<String>

We expect this to only return a Model of some kind.

pub fn joined_model(&self) -> TokenStream

Trait Implementations

impl Clone for ColumnMetadata

fn clone(&self) -> ColumnMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnMetadata

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

Formats the value using the given formatter.

impl Default for ColumnMetadata

fn default() -> Self

Returns the “default value” for a type.

impl TryFrom<&Field> for ColumnMetadata

type Error = SyndecodeError

The type returned in the event of a conversion error.

fn try_from(f: &Field) -> Result<Self, Self::Error>

Performs the conversion.