Enum datafusion::scalar::ScalarValue

pub enum ScalarValue {
    Boolean(Option<bool>),
    Float32(Option<f32>),
    Float64(Option<f64>),
    Int8(Option<i8>),
    Int16(Option<i16>),
    Int32(Option<i32>),
    Int64(Option<i64>),
    UInt8(Option<u8>),
    UInt16(Option<u16>),
    UInt32(Option<u32>),
    UInt64(Option<u64>),
    Utf8(Option<String>),
    LargeUtf8(Option<String>),
    Binary(Option<Vec<u8>>),
    LargeBinary(Option<Vec<u8>>),
    List(Option<Vec<ScalarValue>>, DataType),
    Date32(Option<i32>),
    Date64(Option<i64>),
    TimestampSecond(Option<i64>),
    TimestampMillisecond(Option<i64>),
    TimestampMicrosecond(Option<i64>),
    TimestampNanosecond(Option<i64>),
    IntervalYearMonth(Option<i32>),
    IntervalDayTime(Option<i64>),
}

Represents a dynamically typed, nullable single value. This is the single-valued counter-part of arrow’s Array.

Variants

Boolean(Option<bool>)

true or false value

Float32(Option<f32>)

32bit float

Float64(Option<f64>)

64bit float

Int8(Option<i8>)

signed 8bit int

Int16(Option<i16>)

signed 16bit int

Int32(Option<i32>)

signed 32bit int

Int64(Option<i64>)

signed 64bit int

UInt8(Option<u8>)

unsigned 8bit int

UInt16(Option<u16>)

unsigned 16bit int

UInt32(Option<u32>)

unsigned 32bit int

UInt64(Option<u64>)

unsigned 64bit int

Utf8(Option<String>)

utf-8 encoded string.

LargeUtf8(Option<String>)

utf-8 encoded string representing a LargeString’s arrow type.

Binary(Option<Vec<u8>>)

binary

LargeBinary(Option<Vec<u8>>)

large binary

List(Option<Vec<ScalarValue>>, DataType)

list of nested ScalarValue

Date32(Option<i32>)

Date stored as a signed 32bit int

Date64(Option<i64>)

Date stored as a signed 64bit int

TimestampSecond(Option<i64>)

Timestamp Second

TimestampMillisecond(Option<i64>)

Timestamp Milliseconds

TimestampMicrosecond(Option<i64>)

Timestamp Microseconds

TimestampNanosecond(Option<i64>)

Timestamp Nanoseconds

IntervalYearMonth(Option<i32>)

Interval with YearMonth unit

IntervalDayTime(Option<i64>)

Interval with DayTime unit

Implementations

impl ScalarValue

pub fn get_datatype(&self) -> DataType

Getter for the DataType of the value

pub fn arithmetic_negate(&self) -> Self

Calculate arithmetic negation for a scalar value

pub fn is_null(&self) -> bool

whether this value is null or not.

pub fn to_array(&self) -> ArrayRef

Converts a scalar value into an 1-row array.

pub fn to_array_of_size(&self, size: usize) -> ArrayRef

Converts a scalar value into an array of size rows.

pub fn try_from_array(array: &ArrayRef, index: usize) -> Result<Self>

Converts a value in array at index into a ScalarValue

Trait Implementations

impl Clone for ScalarValue

fn clone(&self) -> ScalarValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScalarValue

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

Formats the value using the given formatter.

impl Display for ScalarValue

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

Formats the value using the given formatter.

impl From<bool> for ScalarValue

fn from(value: bool) -> Self

Performs the conversion.

impl From<f32> for ScalarValue

fn from(value: f32) -> Self

Performs the conversion.

impl From<f64> for ScalarValue

fn from(value: f64) -> Self

Performs the conversion.

impl From<i16> for ScalarValue

fn from(value: i16) -> Self

Performs the conversion.

impl From<i32> for ScalarValue

fn from(value: i32) -> Self

Performs the conversion.

impl From<i64> for ScalarValue

fn from(value: i64) -> Self

Performs the conversion.

impl From<i8> for ScalarValue

fn from(value: i8) -> Self

Performs the conversion.

impl From<u16> for ScalarValue

fn from(value: u16) -> Self

Performs the conversion.

impl From<u32> for ScalarValue

fn from(value: u32) -> Self

Performs the conversion.

impl From<u64> for ScalarValue

fn from(value: u64) -> Self

Performs the conversion.

impl From<u8> for ScalarValue

fn from(value: u8) -> Self

Performs the conversion.

impl Literal for ScalarValue

fn lit(&self) -> Expr

convert the value to a Literal expression

impl PartialEq<ScalarValue> for ScalarValue

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

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

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

This method tests for !=.

impl StructuralPartialEq for ScalarValue

impl TryFrom<&'_ DataType> for ScalarValue

type Error = DataFusionError

The type returned in the event of a conversion error.

fn try_from(datatype: &DataType) -> Result<Self>

Performs the conversion.