Enum Value

pub enum Value {
Show 23 variants
    Bool(bool),
    I8(i8),
    I16(i16),
    I32(i32),
    I64(i64),
    U8(u8),
    U16(u16),
    U32(u32),
    U64(u64),
    SparseRecord(SparseRecord),
    Null,
    Record(ValueRecord),
    List(Vec<Value>),
    String(String),
    Bytes(Vec<u8>),
    Uuid(Uuid),
    Decimal(Decimal),
    BigDecimal(BigDecimal),
    Timestamp(Timestamp),
    Zoned(Zoned),
    Date(Date),
    Time(Time),
    DateTime(DateTime),
}

Expand description

A dynamically typed value used throughout Toasty’s query engine.

Value represents any concrete data value that flows through the query pipeline: field values read from or written to the database, literal constants in expressions, and intermediate results during query evaluation.

Each variant wraps a Rust type that corresponds to a Type variant. Use Value::infer_ty to obtain the matching type, and Value::is_a to check compatibility.

§Construction

Values are typically created via From conversions from Rust primitives:

use toasty_core::stmt::Value;

let v = Value::from(42_i64);
assert_eq!(v, 42_i64);

let v = Value::from("hello");
assert_eq!(v, "hello");

let v = Value::null();
assert!(v.is_null());

let v = Value::from(true);
assert_eq!(v, true);

Variants§

§

Bool(bool)

Boolean value

§

I8(i8)

Signed 8-bit integer

§

I16(i16)

Signed 16-bit integer

§

I32(i32)

Signed 32-bit integer

§

I64(i64)

Signed 64-bit integer

§

U8(u8)

Unsigned 8-bit integer

§

U16(u16)

Unsigned 16-bit integer

§

U32(u32)

Unsigned 32-bit integer

§

U64(u64)

Unsigned 64-bit integer

§

SparseRecord(SparseRecord)

A typed record

§

Null

Null value

§

Record(ValueRecord)

Record value, either borrowed or owned

§

List(Vec<Value>)

A list of values of the same type

§

String(String)

String value, either borrowed or owned

§

Bytes(Vec<u8>)

An array of bytes that is more efficient than List(u8)

§

Uuid(Uuid)

128-bit universally unique identifier (UUID)

§

Decimal(Decimal)

A fixed-precision decimal number. See [rust_decimal::Decimal].

§

BigDecimal(BigDecimal)

An arbitrary-precision decimal number. See [bigdecimal::BigDecimal].

§

Timestamp(Timestamp)

An instant in time represented as the number of nanoseconds since the Unix epoch. See [jiff::Timestamp].

§

Zoned(Zoned)

A time zone aware instant in time. See [jiff::Zoned]

§

Date(Date)

A representation of a civil date in the Gregorian calendar. See [jiff::civil::Date].

§

Time(Time)

A representation of civil “wall clock” time. See [jiff::civil::Time].

§

DateTime(DateTime)

A representation of a civil datetime in the Gregorian calendar. See [jiff::civil::DateTime].

Implementations§

§

impl Value

pub fn to_i8(&self) -> Option<i8>

Attempts to convert this value to the target integer type.

Returns None if the value is not an integer variant or is out of range for the target type. Conversion works across all integer widths and signedness.

pub fn to_i8_unwrap(&self) -> i8

Converts this value to the target integer type, panicking on failure.

§Panics

Panics if the value is not an integer variant or is out of range.

pub fn to_i16(&self) -> Option<i16>

Attempts to convert this value to the target integer type.

Returns None if the value is not an integer variant or is out of range for the target type. Conversion works across all integer widths and signedness.

pub fn to_i16_unwrap(&self) -> i16

Converts this value to the target integer type, panicking on failure.

§Panics

Panics if the value is not an integer variant or is out of range.

pub fn to_i32(&self) -> Option<i32>

Attempts to convert this value to the target integer type.

Returns None if the value is not an integer variant or is out of range for the target type. Conversion works across all integer widths and signedness.

pub fn to_i32_unwrap(&self) -> i32

Converts this value to the target integer type, panicking on failure.

§Panics

Panics if the value is not an integer variant or is out of range.

pub fn to_i64(&self) -> Option<i64>

Attempts to convert this value to the target integer type.

Returns None if the value is not an integer variant or is out of range for the target type. Conversion works across all integer widths and signedness.

pub fn to_i64_unwrap(&self) -> i64

Converts this value to the target integer type, panicking on failure.

§Panics

Panics if the value is not an integer variant or is out of range.

pub fn to_u8(&self) -> Option<u8>

Attempts to convert this value to the target integer type.

Returns None if the value is not an integer variant or is out of range for the target type. Conversion works across all integer widths and signedness.

pub fn to_u8_unwrap(&self) -> u8

Converts this value to the target integer type, panicking on failure.

§Panics

Panics if the value is not an integer variant or is out of range.

pub fn to_u16(&self) -> Option<u16>

Attempts to convert this value to the target integer type.

Returns None if the value is not an integer variant or is out of range for the target type. Conversion works across all integer widths and signedness.

pub fn to_u16_unwrap(&self) -> u16

Converts this value to the target integer type, panicking on failure.

§Panics

Panics if the value is not an integer variant or is out of range.

pub fn to_u32(&self) -> Option<u32>

Attempts to convert this value to the target integer type.

Returns None if the value is not an integer variant or is out of range for the target type. Conversion works across all integer widths and signedness.

pub fn to_u32_unwrap(&self) -> u32

Converts this value to the target integer type, panicking on failure.

§Panics

Panics if the value is not an integer variant or is out of range.

pub fn to_u64(&self) -> Option<u64>

Attempts to convert this value to the target integer type.

Returns None if the value is not an integer variant or is out of range for the target type. Conversion works across all integer widths and signedness.

pub fn to_u64_unwrap(&self) -> u64

Converts this value to the target integer type, panicking on failure.

§Panics

Panics if the value is not an integer variant or is out of range.

§

impl Value

pub fn empty_sparse_record() -> Value

Creates an empty Value::SparseRecord with no populated fields.

pub fn sparse_record(fields: PathFieldSet, record: ValueRecord) -> Value

Creates a Value::SparseRecord by distributing values from record into the positions specified by fields.

pub fn into_sparse_record(self) -> SparseRecord

Consumes this value and returns the contained SparseRecord, panicking if this is not a Value::SparseRecord.

§Panics

Panics if the value is not a SparseRecord variant.

§

impl Value

pub const fn null() -> Value

Returns a null value.

§Examples

let v = Value::null();
assert!(v.is_null());

pub const fn is_null(&self) -> bool

Returns true if this value is Value::Null.

§Examples

assert!(Value::Null.is_null());
assert!(!Value::from(1_i64).is_null());

pub const fn is_record(&self) -> bool

Returns true if this value is a Value::Record.

pub fn record_from_vec(fields: Vec<Value>) -> Value

Creates a Value::Record from a vector of field values.

§Examples

let record = Value::record_from_vec(vec![Value::from(1_i64), Value::from("name")]);
assert!(record.is_record());

pub const fn from_bool(src: bool) -> Value

Creates a boolean value.

§Examples

let v = Value::from_bool(true);
assert_eq!(v, true);

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

Returns the contained string slice if this is a Value::String, or None otherwise.

pub fn as_string_unwrap(&self) -> &str

Returns the contained string slice, panicking if this is not a Value::String.

§Panics

Panics if the value is not a String variant.

pub fn as_record(&self) -> Option<&ValueRecord>

Returns a reference to the contained ValueRecord if this is a Value::Record, or None otherwise.

pub fn as_record_unwrap(&self) -> &ValueRecord

Returns a reference to the contained ValueRecord, panicking if this is not a Value::Record.

§Panics

Panics if the value is not a Record variant.

pub fn as_record_mut_unwrap(&mut self) -> &mut ValueRecord

Returns a mutable reference to the contained ValueRecord, panicking if this is not a Value::Record.

§Panics

Panics if the value is not a Record variant.

pub fn into_record(self) -> ValueRecord

Consumes this value and returns the contained ValueRecord, panicking if this is not a Value::Record.

§Panics

Panics if the value is not a Record variant.

pub fn is_a(&self, ty: &Type) -> bool

Returns true if this value is compatible with the given Type.

Null values are compatible with any type. For union types, the value must be compatible with at least one member type.

pub fn infer_ty(&self) -> Type

Infers and returns the Type of this value.

§Examples

assert_eq!(Value::from(42_i64).infer_ty(), Type::I64);
assert_eq!(Value::from("hello").infer_ty(), Type::String);
assert_eq!(Value::Null.infer_ty(), Type::Null);

pub fn entry(&self, path: impl EntryPath) -> Entry<'_>

Navigates into this value using the given path and returns an Entry reference to the nested value.

For records, each step indexes into the record’s fields. For lists, each step indexes into the list’s elements.

§Panics

Panics if the path is invalid for the value’s structure.

pub fn take(&mut self) -> Value

Takes the value out, replacing it with Value::Null.

§Examples

let mut v = Value::from(42_i64);
let taken = v.take();
assert_eq!(taken, 42_i64);
assert!(v.is_null());

§

impl Value

pub fn list_from_vec(items: Vec<Value>) -> Value

Creates a Value::List from a vector of values.

§Examples

let list = Value::list_from_vec(vec![Value::from(1_i64), Value::from(2_i64)]);
assert!(list.is_list());

pub fn is_list(&self) -> bool

Returns true if this value is a Value::List.

pub fn into_list_unwrap(self) -> Vec<Value>

Consumes this value and returns the inner Vec<Value>, panicking if this is not a Value::List.

§Panics

Panics if the value is not a List variant.

Trait Implementations§

§

impl AsRef<Value> for Value

§

fn as_ref(&self) -> &Value

Converts this type into a shared reference of the (usually inferred) input type.

§

impl Clone for Value

§

fn clone(&self) -> Value

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

§

impl Debug for Value

§

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

Formats the value using the given formatter. Read more

§

impl Default for Value

§

fn default() -> Value

Returns the “default value” for a type. Read more

§