Skip to main content

ColumnInfo

Struct ColumnInfo 

Source
pub struct ColumnInfo {
    pub name: &'static str,
    pub rust_type: &'static str,
    pub is_primary_key: bool,
    pub is_auto_increment: bool,
    pub is_index: bool,
    pub is_unique: bool,
    pub unique_index_name: Option<&'static str>,
}
Expand description

Metadata about a single column in a model’s table schema.

Generated automatically by #[derive(DeriveModel)] and used by [QueryBuilder::create_table] to generate DDL statements.

§Example

use grorm::{DeriveModel, ColumnInfo, Model};

#[derive(Debug, DeriveModel)]
#[table = "users"]
struct User {
    id: i64,
    #[index]
    name: String,
    #[unique]
    email: String,
    age: i32,
}

let schema = User::table_schema();
assert_eq!(schema.len(), 4);
assert!(schema[0].is_primary_key);
assert!(schema[1].is_index);
assert!(schema[2].is_unique);

Fields§

§name: &'static str

Column name in the database

§rust_type: &'static str

Rust type name (e.g. "i64", "String")

§is_primary_key: bool

Whether this column is part of the primary key

§is_auto_increment: bool

Whether this column is auto-increment (integer primary key)

§is_index: bool

Whether a regular index should be created on this column (#[index])

§is_unique: bool

Whether a unique constraint should be created on this column (#[unique])

§unique_index_name: Option<&'static str>

Name of the composite unique index group (#[unique_index = "name"]). Columns with the same name form a composite unique index.

Trait Implementations§

Source§

impl Clone for ColumnInfo

Source§

fn clone(&self) -> ColumnInfo

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 ColumnInfo

Source§

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

Formats the value using the given formatter. Read more

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> Same for T

Source§

type Output = T

Should always be Self
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.