Struct ColumnMetadata

#[non_exhaustive]
pub struct ColumnMetadata {

    pub name: Option<String>,
    pub type: i32,
    pub type_name: Option<String>,
    pub label: Option<String>,
    pub schema_name: Option<String>,
    pub table_name: Option<String>,
    pub is_auto_increment: bool,
    pub is_signed: bool,
    pub is_currency: bool,
    pub is_case_sensitive: bool,
    pub nullable: i32,
    pub precision: i32,
    pub scale: i32,
    pub array_base_column_type: i32,
}

Contains the metadata for a column.

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: Option<String>

The name of the column.

type: i32

The type of the column.

type_name: Option<String>

The database-specific data type of the column.

label: Option<String>

The label for the column.

schema_name: Option<String>

The name of the schema that owns the table that includes the column.

table_name: Option<String>

The name of the table that includes the column.

is_auto_increment: bool

A value that indicates whether the column increments automatically.

is_signed: bool

A value that indicates whether an integer column is signed.

is_currency: bool

A value that indicates whether the column contains currency values.

is_case_sensitive: bool

A value that indicates whether the column is case-sensitive.

nullable: i32

A value that indicates whether the column is nullable.

precision: i32

The precision value of a decimal number column.

scale: i32

The scale value of a decimal number column.

array_base_column_type: i32

The type of the column.

Implementations

impl ColumnMetadata

pub fn name(&self) -> Option<&str>

The name of the column.

pub fn type(&self) -> i32

The type of the column.

pub fn type_name(&self) -> Option<&str>

The database-specific data type of the column.

pub fn label(&self) -> Option<&str>

The label for the column.

pub fn schema_name(&self) -> Option<&str>

The name of the schema that owns the table that includes the column.

pub fn table_name(&self) -> Option<&str>

The name of the table that includes the column.

pub fn is_auto_increment(&self) -> bool

A value that indicates whether the column increments automatically.

pub fn is_signed(&self) -> bool

A value that indicates whether an integer column is signed.

pub fn is_currency(&self) -> bool

A value that indicates whether the column contains currency values.

pub fn is_case_sensitive(&self) -> bool

A value that indicates whether the column is case-sensitive.

pub fn nullable(&self) -> i32

A value that indicates whether the column is nullable.

pub fn precision(&self) -> i32

The precision value of a decimal number column.

pub fn scale(&self) -> i32

The scale value of a decimal number column.

pub fn array_base_column_type(&self) -> i32

The type of the column.

impl ColumnMetadata

pub fn builder() -> ColumnMetadataBuilder

Creates a new builder-style object to manufacture ColumnMetadata.

Trait Implementations

impl Clone for ColumnMetadata

fn clone(&self) -> ColumnMetadata

Returns a duplicate of the value.

const 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 PartialEq for ColumnMetadata

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

Tests for self and other values to be equal, and is used by ==.

const 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 StructuralPartialEq for ColumnMetadata