Struct ColumnDefinition 

pub struct ColumnDefinition {
    pub name: String,
    pub nullable: bool,
    /* private fields */
}

A column definition.

This struct supports both string-based type names (for simplicity) and SqlType-based definitions (for type safety). Internally, it uses a single source of truth to avoid synchronization issues.

Fields

name: String

Column name.

nullable: bool

Whether the column is nullable.

Implementations

impl ColumnDefinition

pub fn new( name: impl Into<String>, type_name: impl Into<String>, nullable: bool, ) -> Self

Creates a new column definition using a type name string.

Example

use hyperdb_api::ColumnDefinition;

let col = ColumnDefinition::new("id", "INT", false);
assert_eq!(col.name, "id");
assert_eq!(col.type_name(), "INT");

pub fn with_sql_type( name: impl Into<String>, sql_type: SqlType, nullability: Nullability, ) -> Self

Creates a column definition using SqlType.

Example

use hyperdb_api::ColumnDefinition;
use hyperdb_api_core::types::{SqlType, Nullability};

let col = ColumnDefinition::with_sql_type("id", SqlType::int(), Nullability::NotNullable);
assert_eq!(col.name, "id");
assert!(!col.nullable);

pub fn with_collation( name: impl Into<String>, sql_type: SqlType, collation: impl Into<String>, nullability: Nullability, ) -> Self

Creates a column definition with a collation.

The collation specifies the sorting and comparison behavior for text columns.

Example

use hyperdb_api::ColumnDefinition;
use hyperdb_api_core::types::{SqlType, Nullability};

let col = ColumnDefinition::with_collation("name", SqlType::text(), "en_US", Nullability::Nullable);
assert_eq!(col.collation(), Some("en_US"));

pub fn nullable(name: impl Into<String>, sql_type: SqlType) -> Self

Creates a nullable column definition using SqlType.

pub fn not_null(name: impl Into<String>, sql_type: SqlType) -> Self

Creates a non-nullable column definition using SqlType.

pub fn nullability(&self) -> Nullability

Returns the nullability as a Nullability enum.

pub fn sql_type(&self) -> Option<SqlType>

Returns the SQL type if this column was created with a structured type.

pub fn type_name(&self) -> Cow<'_, str>

Returns the type name string representation.

When created with SqlType, this is derived from it. Otherwise, it’s the string provided during construction.

Returns Cow<str> to avoid allocation when the type name is already stored as a string internally.

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

Returns the collation if set.

pub fn set_collation(&mut self, collation: impl Into<String>)

Sets the collation for this column.

pub fn set_sql_type(&mut self, sql_type: SqlType)

Sets the SQL type, replacing any previous type information.

This replaces the internal type representation with the provided SqlType.

pub fn to_types_column_definition(&self) -> Option<TypesColumnDefinition>

Converts to the hyper-types ColumnDefinition (if SqlType is set).

Trait Implementations

impl Clone for ColumnDefinition

fn clone(&self) -> ColumnDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnDefinition

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

Formats the value using the given formatter.

impl From<ColumnDefinition> for ColumnDefinition

fn from(col: TypesColumnDefinition) -> Self

Converts to this type from the input type.