Enum deltalake::kernel::Scalar

pub enum Scalar {
    Integer(i32),
    Long(i64),
    Short(i16),
    Byte(i8),
    Float(f32),
    Double(f64),
    String(String),
    Boolean(bool),
    Timestamp(i64),
    TimestampNtz(i64),
    Date(i32),
    Binary(Vec<u8>),
    Decimal(i128, u8, i8),
    Null(DataType),
    Struct(Vec<Scalar>, Vec<StructField>),
}

A single value, which can be null. Used for representing literal values in [Expressions][crate::expressions::Expression].

Variants

Integer(i32)

32bit integer

Long(i64)

64bit integer

Short(i16)

16bit integer

Byte(i8)

8bit integer

Float(f32)

32bit floating point

Double(f64)

64bit floating point

String(String)

utf-8 encoded string.

Boolean(bool)

true or false value

Timestamp(i64)

Microsecond precision timestamp, adjusted to UTC.

TimestampNtz(i64)

Microsecond precision timestamp, with no timezone.

Date(i32)

Date stored as a signed 32bit int days since UNIX epoch 1970-01-01

Binary(Vec<u8>)

Binary data

Decimal(i128, u8, i8)

Decimal value

Null(DataType)

Null value with a given data type.

Struct(Vec<Scalar>, Vec<StructField>)

Struct value

Implementations

impl Scalar

pub fn to_array(&self, num_rows: usize) -> Result<Arc<dyn Array>, Error>

Convert scalar to arrow array.

impl Scalar

pub fn data_type(&self) -> DataType

Returns the data type of this scalar.

pub fn is_null(&self) -> bool

Returns true if this scalar is null.

pub fn serialize(&self) -> String

Serializes this scalar as a string.

pub fn serialize_encoded(&self) -> String

Serializes this scalar as a string for use in hive partition file names.

pub fn from_array(arr: &dyn Array, index: usize) -> Option<Scalar>

Create a Scalar form a row in an arrow array.

Trait Implementations

impl Clone for Scalar

fn clone(&self) -> Scalar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scalar

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

Formats the value using the given formatter.

impl Display for Scalar

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

Formats the value using the given formatter.

impl From<&str> for Scalar

fn from(s: &str) -> Scalar

Converts to this type from the input type.

impl From<String> for Scalar

fn from(value: String) -> Scalar

Converts to this type from the input type.

impl From<bool> for Scalar

fn from(b: bool) -> Scalar

Converts to this type from the input type.

impl From<i32> for Scalar

fn from(i: i32) -> Scalar

Converts to this type from the input type.

impl From<i64> for Scalar

fn from(i: i64) -> Scalar

Converts to this type from the input type.

impl PartialEq for Scalar

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Scalar

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for Scalar