Enum Value

pub enum Value {
    Boolean(bool),
    Int(i32),
    LongInt(i64),
    Float(OrderedFloat<f32>),
    Double(OrderedFloat<f64>),
    Date(i32),
    Time(i64),
    Timestamp(i64),
    TimestampTZ(i64),
    String(String),
    UUID(Uuid),
    Fixed(usize, Vec<u8>),
    Binary(Vec<u8>),
    Decimal(Decimal),
    Struct(Struct),
    List(Vec<Option<Value>>),
    Map(BTreeMap<Value, Option<Value>>),
}

Values present in iceberg type

Variants

Boolean(bool)

0x00 for false, non-zero byte for true

Int(i32)

Stored as 4-byte little-endian

LongInt(i64)

Stored as 8-byte little-endian

Float(OrderedFloat<f32>)

Stored as 4-byte little-endian

Double(OrderedFloat<f64>)

Stored as 8-byte little-endian

Date(i32)

Stores days from the 1970-01-01 in an 4-byte little-endian int

Time(i64)

Stores microseconds from midnight in an 8-byte little-endian long

Timestamp(i64)

Stores microseconds from 1970-01-01 00:00:00.000000 in an 8-byte little-endian long

TimestampTZ(i64)

Stores microseconds from 1970-01-01 00:00:00.000000 in an 8-byte little-endian long

String(String)

UTF-8 bytes (without length)

UUID(Uuid)

16-byte big-endian value

Fixed(usize, Vec<u8>)

Binary value

Binary(Vec<u8>)

Binary value (without length)

Decimal(Decimal)

Stores unscaled value as two’s-complement big-endian binary, using the minimum number of bytes for the value

Struct(Struct)

A struct is a tuple of typed values. Each field in the tuple is named and has an integer id that is unique in the table schema. Each field can be either optional or required, meaning that values can (or cannot) be null. Fields may be any type. Fields may have an optional comment or doc string. Fields can have default values.

List(Vec<Option<Value>>)

A list is a collection of values with some element type. The element field has an integer id that is unique in the table schema. Elements can be either optional or required. Element types may be any type.

Map(BTreeMap<Value, Option<Value>>)

A map is a collection of key-value pairs with a key type and a value type. Both the key field and value field each have an integer id that is unique in the table schema. Map keys are required and map values can be either optional or required. Both map keys and map values may be any type, including nested types.

Implementations

impl Value

pub fn transform(&self, transform: &Transform) -> Result<Value, Error>

Applies a partition transform to the value

Arguments

• transform - The partition transform to apply

Returns

• Ok(Value) - The transformed value
• Err(Error) - If the transform cannot be applied to this value type

Supported transforms include:

• Identity - Returns the value unchanged
• Bucket - Applies a hash function and returns bucket number
• Truncate - Truncates numbers or strings
• Year/Month/Day/Hour - Extracts time components from dates and timestamps

pub fn try_from_bytes(bytes: &[u8], data_type: &Type) -> Result<Self, Error>

Attempts to create a Value from raw bytes according to a specified type

Arguments

• bytes - The raw byte slice to parse
• data_type - The expected type of the value

Returns

• Ok(Value) - Successfully parsed value of the specified type
• Err(Error) - If the bytes cannot be parsed as the specified type

Note

Currently only supports primitive types. Complex types like structs, lists, and maps are not supported and will return an error.

pub fn try_from_json( value: JsonValue, data_type: &Type, ) -> Result<Option<Self>, Error>

Attempts to create a Value from a JSON value according to a specified type

Arguments

• value - The JSON value to parse
• data_type - The expected Iceberg type

Returns

• Ok(Some(Value)) - Successfully parsed value of the specified type
• Ok(None) - If the JSON value is null
• Err(Error) - If the JSON value cannot be parsed as the specified type

Note

Handles all primitive types as well as complex types like structs, lists and maps. For complex types, recursively parses their contents according to their type specifications.

pub fn datatype(&self) -> Type

Returns the Iceberg Type that corresponds to this Value

Returns

• The Type (primitive or complex) that matches this Value’s variant

Note

Currently only implemented for primitive types. Complex types like structs, lists, and maps will cause a panic.

pub fn into_any(self) -> Box<dyn Any>

Converts this Value into a boxed Any trait object

Returns

• Box<dyn Any> containing the underlying value

Note

Currently only implemented for primitive types. Complex types like structs, lists, and maps will panic with unimplemented!()

pub fn cast(self, data_type: &Type) -> Result<Self, Error>

Attempts to cast this Value to a different Type

Arguments

• data_type - The target Type to cast to

Returns

• Ok(Value) - Successfully cast Value of the target type
• Err(Error) - If the value cannot be cast to the target type

Note

Currently supports casting between numeric types (Int -> Long, Int -> Date, etc) and temporal types (Long -> Time/Timestamp/TimestampTZ). Returns the original value if the target type matches the current type.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Value

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Value

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

Formats the value using the given formatter.

impl From<&Value> for Value

fn from(value: &Value) -> Self

Converts to this type from the input type.

impl From<Value> for ByteBuf

fn from(value: Value) -> Self

Converts to this type from the input type.

impl Hash for Value

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Value

fn cmp(&self, other: &Value) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Value

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Value

fn partial_cmp(&self, other: &Value) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Value

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TrySub for Value

fn try_sub(&self, other: &Self) -> Result<Self, Error>

impl Eq for Value

impl StructuralPartialEq for Value