Struct LogicalTypeHandle 

pub struct LogicalTypeHandle { /* private fields */ }

DuckDB Logical Type. https://duckdb.org/docs/sql/data_types/overview

Implementations

impl LogicalTypeHandle

pub fn map(key: &Self, value: &Self) -> Self

Creates a map type from its child type.

pub fn list(child_type: &Self) -> Self

Creates a list type from its child type.

pub fn array(child_type: &Self, array_size: u64) -> Self

Creates an array type from its child type.

pub fn decimal(width: u8, scale: u8) -> Self

Creates a decimal type from its width and scale.

pub fn decimal_width(&self) -> u8

Retrieves the decimal width Returns 0 if the LogicalType is not a decimal

pub fn decimal_scale(&self) -> u8

Retrieves the decimal scale Returns 0 if the LogicalType is not a decimal

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

Returns the CRS metadata for a GEOMETRY logical type.

Returns None when this logical type is not GEOMETRY or DuckDB does not carry CRS metadata for the geometry type.

pub fn struct_type(fields: &[(&str, Self)]) -> Self

Make a LogicalType for struct

pub fn union_type(fields: &[(&str, Self)]) -> Self

Make a LogicalType for union

pub fn id(&self) -> LogicalTypeId

Logical type ID

pub fn try_id(&self) -> Result<LogicalTypeId, u32>

Logical type ID, with forward-compatibility awareness.

Returns Ok(LogicalTypeId) for all known ids (including Invalid), and Err(raw_id) when DuckDB returns an id this wrapper does not yet recognize.

pub fn raw_id(&self) -> u32

Raw logical type id returned by DuckDB C API

pub fn num_children(&self) -> usize

Logical type children num

pub fn child_name(&self, idx: usize) -> String

Logical type child name by idx

Invalid UTF-8 bytes are replaced with the Unicode replacement character.

Panics if the logical type is not a struct or union, or if idx is out of range.

pub fn try_child_name(&self, idx: usize) -> Result<String>

Logical type child name by idx, rejecting invalid UTF-8.

Panics if the logical type is not a struct or union, or if idx is out of range.

pub fn child(&self, idx: usize) -> Self

Logical type child by idx.

Panics if the logical type has no children, if idx is out of range, or if the logical type is LogicalTypeId::Unsupported.

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

Alias of the logical type.

pub fn set_alias(&mut self, alias: &str)

Set the alias of the logical type.

Trait Implementations

impl Debug for LogicalTypeHandle

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

Debug implementation for LogicalType

impl Drop for LogicalTypeHandle

fn drop(&mut self)

Drop implementation for LogicalType

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl From<LogicalTypeId> for LogicalTypeHandle

fn from(id: LogicalTypeId) -> Self

Create a new LogicalTypeHandle from LogicalTypeId.

Panics

Panics for LogicalTypeId::Invalid and LogicalTypeId::Unsupported, which cannot be constructed as valid logical types.