Struct TypeRef 

pub struct TypeRef<'a> { /* private fields */ }

Borrowed view of a ClickHouse type.

Implementations

impl<'a> TypeRef<'a>

pub fn kind(&self) -> Option<Kind>

pub fn n_children(&self) -> usize

Returns number of child types.

Child types include array elements, tuple and nested fields, map keys and values, aggregate function argument types, and inner types of Nullable and LowCardinality.

pub fn child(&self, i: usize) -> Option<TypeRef<'a>>

pub fn fixed_size(&self) -> i32

Returns N for FixedString(N), or zero for other types.

pub fn elem_size(&self) -> usize

Returns byte width in a Fixed column. Returns zero for types without fixed-width storage.

pub fn decimal_precision(&self) -> i32

Returns P for Decimal(P, S), or zero for other types.

pub fn decimal_scale(&self) -> i32

Returns S for Decimal(P, S), or zero for other types.

pub fn datetime64_scale(&self) -> i32

Returns subsecond precision for DateTime64(S) or Time64(S). Returns zero for other types.

pub fn interval_unit(&self) -> Option<IntervalUnit>

Returns unit for an Interval* type, or None for other types.

pub fn qbit_dimension(&self) -> usize

Returns N for QBit(T, N), or zero for other types.

A QBit column uses ColumnLayout::Tuple with one fixed column per bit in T. Columns use most significant bit first, and each row holds ceil(N / 8) bytes.

pub fn qbit_element_size(&self) -> usize

Returns bit width of T in QBit(T, N), or zero for other types. Supported widths are 16, 32, and 64.

pub fn timezone(&self) -> Option<&'a [u8]>

Returns timezone bytes without UTF-8 validation.

pub fn name(&self) -> Option<&'a [u8]>

Returns type name bytes without UTF-8 validation.

pub fn enum_count(&self) -> usize

Returns number of entries for Enum8 or Enum16. Returns zero for other types.

pub fn enum_at(&self, i: usize) -> Option<(&'a [u8], i64)>

Returns name and value for enum entry at i. Name bytes are not validated as UTF-8.

pub fn tuple_field_name(&self, i: usize) -> Option<&'a [u8]>

Returns Tuple or Nested field name bytes without UTF-8 validation.

pub fn agg_function(&self) -> Option<&'a [u8]>

Returns function name of AggregateFunction or SimpleAggregateFunction without UTF-8 validation.

Function parameters are not part of name. Children hold argument types, first of which carries stored values.

pub fn format(&self) -> String

Formats type as a ClickHouse type name.

Trait Implementations

impl<'a> Clone for TypeRef<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for TypeRef<'a>