Enum ValueRef 

#[non_exhaustive]
pub enum ValueRef<'a> {
    Null,
    Boolean(bool),
    TinyInt(i8),
    SmallInt(i16),
    Int(i32),
    BigInt(i64),
    HugeInt(i128),
    UHugeInt(u128),
    UTinyInt(u8),
    USmallInt(u16),
    UInt(u32),
    UBigInt(u64),
    Float(f32),
    Double(f64),
    Decimal(Decimal),
    Timestamp(TimeUnit, i64),
    Text(&'a [u8]),
    Blob(&'a [u8]),
    Geometry(&'a [u8]),
    Date32(i32),
    Time64(TimeUnit, i64),
    Interval {
        months: i32,
        days: i32,
        nanos: i64,
    },
    List(ListType<'a>, usize),
    Enum(EnumType<'a>, usize),
    Struct(&'a StructArray, usize),
    Array(&'a FixedSizeListArray, usize),
    Map(&'a MapArray, usize),
    Union(&'a ArrayRef, usize),
}

A non-owning static type value. Typically the memory backing this value is owned by DuckDB.

Container variants decode child values without DuckDB child logical type metadata. See the crate::types compatibility notes for UHUGEINT behavior inside containers.

See Value for an owning dynamic type value.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Null

The value is a NULL value.

Boolean(bool)

The value is a boolean.

TinyInt(i8)

The value is a signed tiny integer.

SmallInt(i16)

The value is a signed small integer.

Int(i32)

The value is a signed integer.

BigInt(i64)

The value is a signed big integer.

HugeInt(i128)

The value is a signed huge integer.

UHugeInt(u128)

The value is an unsigned huge integer.

Top-level UHUGEINT result values decode to this variant because row decoding uses DuckDB logical type metadata. Borrowed container values do not carry that metadata and cannot recover nested UHUGEINT values above i128::MAX.

UTinyInt(u8)

The value is a unsigned tiny integer.

USmallInt(u16)

The value is a unsigned small integer.

UInt(u32)

The value is a unsigned integer.

UBigInt(u64)

The value is a unsigned big integer.

Float(f32)

The value is a f32.

Double(f64)

The value is a f64.

Decimal(Decimal)

The value is a DuckDB decimal.

Decimal stores DuckDB’s decimal width, scale, and scaled integer payload.

Timestamp(TimeUnit, i64)

The value is a timestamp.

Text(&'a [u8])

The value is a text string.

Blob(&'a [u8])

The value is a blob of data

Geometry(&'a [u8])

The value is a top-level GEOMETRY, represented as WKB bytes.

Nested GEOMETRY values currently materialize through their Arrow binary carrier as Blob values. See Value::Geometry for binding and appender guidance.

Date32(i32)

The value is a date32

Time64(TimeUnit, i64)

The value is a time64

Interval

The value is an interval (month, day, nano)

Fields

months: i32

months

days: i32

days

nanos: i64

nanos

List(ListType<'a>, usize)

The value is a list.

Enum(EnumType<'a>, usize)

The value is an enum

Struct(&'a StructArray, usize)

The value is a struct.

Array(&'a FixedSizeListArray, usize)

The value is an array.

Map(&'a MapArray, usize)

The value is a map.

Union(&'a ArrayRef, usize)

The value is a union.

Implementations

impl ValueRef<'_>

pub fn data_type(&self) -> Type

Returns DuckDB fundamental datatype.

pub fn to_owned(&self) -> Value

Returns an owned version of this ValueRef

impl<'a> ValueRef<'a>

pub fn as_str(&self) -> FromSqlResult<&'a str>

If self is Text or Enum, returns the string value. Otherwise, returns Err(FromSqlError::InvalidType).

pub fn as_blob(&self) -> FromSqlResult<&'a [u8]>

If self is Blob, Text, or Geometry, returns the byte slice. Otherwise, returns Err(FromSqlError::InvalidType).

pub fn as_geometry_wkb(&self) -> FromSqlResult<&'a [u8]>

If self is Geometry, returns the WKB byte slice. Otherwise, returns Err(FromSqlError::InvalidType).

Trait Implementations

impl<'a> Clone for ValueRef<'a>

fn clone(&self) -> ValueRef<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for ValueRef<'a>

impl<'a> Debug for ValueRef<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a Value> for ValueRef<'a>

fn from(value: &'a Value) -> Self

Converts non-container Value variants into a borrowed ValueRef.

Panics

Panics for Value::Enum, Value::List, Value::Struct, Value::Map, Value::Array, and Value::Union. Internal bind and append paths use value_ref_from_value for fallible conversion.

impl<'a> From<&'a [u8]> for ValueRef<'a>

fn from(s: &[u8]) -> ValueRef<'_>

Converts to this type from the input type.

impl<'a> From<&'a str> for ValueRef<'a>

fn from(s: &str) -> ValueRef<'_>

Converts to this type from the input type.

impl From<Decimal> for ValueRef<'_>

fn from(decimal: Decimal) -> Self

Converts to this type from the input type.

impl<'a, T> From<Option<T>> for ValueRef<'a>

where T: Into<Self>,

fn from(s: Option<T>) -> Self

Converts to this type from the input type.

impl From<ValueRef<'_>> for Value

fn from(borrowed: ValueRef<'_>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for ValueRef<'a>

fn eq(&self, other: &ValueRef<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for ValueRef<'a>