Skip to main content

ColumnTypeInfo

Struct ColumnTypeInfo 

Source
#[non_exhaustive]
pub struct ColumnTypeInfo { pub declared_name: String, pub array_dimensions: u32, pub base_type: Option<String>, pub kind: ColumnTypeKind, }
Expand description

Structured type information for a result column.

Returned by Statement::get_column_type_info. Surfaces the array depth and custom-type resolution that the SQLite-compat get_column_decltype API does not expose, and also carries the inferred-affinity result for computed expressions (SELECT 1+1, function calls in subqueries, etc.) — the consumer asks one question, the API decides which path applies.

For a direct table-column reference, declared_name is the literal string the user wrote in CREATE TABLE ("INTEGER", "cents", "VARCHAR"), array_dimensions is the bracket depth, and base_type / kind carry any CREATE TYPE / CREATE DOMAIN resolution.

For a literal (SELECT 42, SELECT 'x', SELECT 3.14), declared_name is the primitive that matches the literal’s parsed value type ("INTEGER", "TEXT", "REAL"). For a typed expression — CAST, rowid, or anything else SQLite’s affinity rules can pin down — it’s the inferred primitive. In both cases array_dimensions is 0, base_type is None, and kind is ColumnTypeKind::Builtin. When neither path produces a usable primitive (binary arithmetic that SQLite refuses to propagate through, BLOB literals, NULL literals, function calls without declared return affinity), get_column_type_info returns Ok(None) rather than fabricating a name — callers can fall through to their own default.

New fields may be added over time; the struct is marked #[non_exhaustive] so consumers must use struct-update or accessor patterns rather than exhaustive matches.

Fields (Non-exhaustive)§

This struct is marked as 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.
§declared_name: String

The declared type name as written in CREATE TABLE — e.g. "INTEGER", "VARCHAR", or the name of a CREATE TYPE / CREATE DOMAIN such as "cents". This is the same string get_column_decltype returns.

§array_dimensions: u32

Array dimensionality: 0 for scalar columns, 1 for INTEGER[], 2 for TEXT[][], etc.

§base_type: Option<String>

For columns whose declared type resolves to a CREATE TYPE or CREATE DOMAIN definition, this is the underlying primitive type name ("INTEGER", "TEXT", "REAL", "BLOB", or "NUMERIC"). None when the declared name is a built-in primitive directly.

Use this to distinguish “the user wrote INTEGER” (base_type: None) from “the user wrote cents, which happens to be INTEGER underneath” (base_type: Some("INTEGER")).

§kind: ColumnTypeKind

Classification of the declared type. Distinguishes BUILTIN (the declared name is a primitive) from the four CREATE TYPE/CREATE DOMAIN flavours.

This matters for callers like wire-protocol layers that need to map a column to its native type code: a column declared as a STRUCT type stores a BLOB on disk (base_type is Some("BLOB")), but the caller usually wants to expose it as a composite/JSON type rather than raw bytes. The kind field carries that distinction directly without forcing the caller to re-query the schema.

Trait Implementations§

Source§

impl Clone for ColumnTypeInfo

Source§

fn clone(&self) -> ColumnTypeInfo

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 ColumnTypeInfo

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ColumnTypeInfo

Source§

impl PartialEq for ColumnTypeInfo

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ColumnTypeInfo

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<K, Q> Equivalent<Q> for K
where K: Borrow<Q> + ?Sized, Q: Eq + ?Sized,

Source§

fn equivalent(&self, key: &Q) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more