Enum ScalarValue

Source

pub enum ScalarValue {
    Bool(bool),
    Primitive(PValue),
    Decimal(DecimalValue),
    Utf8(BufferString),
    Binary(ByteBuffer),
    List(Vec<Option<ScalarValue>>),
}

Expand description

The value stored in a Scalar.

This enum represents the possible non-null values that can be stored in a scalar. When the scalar is null, the value is represented as None in the Option<ScalarValue> field.

Variants§

§

Bool(bool)

A boolean value.

§

Primitive(PValue)

A primitive numeric value.

§

List(Vec<Option<ScalarValue>>)

A list of potentially null scalar values.

Implementations§

Source §

impl ScalarValue

Source

pub fn as_bool(&self) -> bool

Returns the boolean value, panicking if the value is not a Bool.

Source

pub fn as_primitive(&self) -> &PValue

Returns the primitive value, panicking if the value is not a Primitive.

Source

pub fn as_decimal(&self) -> &DecimalValue

Returns the decimal value, panicking if the value is not a Decimal.

Source

pub fn as_utf8(&self) -> &BufferString

Returns the UTF-8 string value, panicking if the value is not a Utf8.

Source

pub fn as_binary(&self) -> &ByteBuffer

Returns the binary value, panicking if the value is not a Binary.

Source

pub fn as_list(&self) -> &[Option<ScalarValue>]

Returns the list elements, panicking if the value is not a List.

Source

pub fn into_bool(self) -> bool

Returns the boolean value, panicking if the value is not a Bool.

Source

pub fn into_primitive(self) -> PValue

Returns the primitive value, panicking if the value is not a Primitive.

Source

pub fn into_decimal(self) -> DecimalValue

Returns the decimal value, panicking if the value is not a Decimal.

Source

pub fn into_utf8(self) -> BufferString

Returns the UTF-8 string value, panicking if the value is not a Utf8.

Source

pub fn into_binary(self) -> ByteBuffer

Returns the binary value, panicking if the value is not a Binary.

Source

pub fn into_list(self) -> Vec<Option<ScalarValue>>

Returns the list elements, panicking if the value is not a List.

Source §

impl ScalarValue

Source

pub fn to_proto(this: Option<&Self>) -> ScalarValue

Ideally, we would not have this function and instead implement this From implementation:

impl From<Option<&ScalarValue>> for pb::ScalarValue { ... }

However, we are not allowed to do this because of the Orphan rule (Option and pb::ScalarValue are not types defined in this crate). So we must make this a method on vortex_array::scalar::ScalarValue directly.

Source

pub fn to_proto_bytes<B: Default + BufMut>(value: Option<&ScalarValue>) -> B

Serialize an optional ScalarValue to protobuf bytes (handles null values).

Source §

impl ScalarValue

Source

pub fn from_proto_bytes( bytes: &[u8], dtype: &DType, ) -> VortexResult<Option<Self>>

Deserialize a ScalarValue from protobuf bytes.

Note that we need to provide a DType since protobuf serialization only supports 64-bit integers, and serializing into protobuf loses that type information.

§Errors

Returns an error if decoding or type validation fails.

Source

pub fn from_proto( value: &ScalarValue, dtype: &DType, ) -> VortexResult<Option<Self>>

Creates a ScalarValue from its protobuf representation.

Note that we need to provide a DType since protobuf serialization only supports 64-bit integers, and serializing into protobuf loses that type information.

§Errors

Returns an error if the protobuf value cannot be converted to the given DType.

Source §

impl ScalarValue

Source

pub fn zero_value(dtype: &DType) -> Self

Returns the zero / identity value for the given DType.

§Zero Values

Here is the list of zero values for each DType (when the DType is non-nullable):

Null: Does not have a “zero” value
Bool: false
Primitive: 0
Decimal: 0
Utf8: ""
Binary: An empty buffer
List: An empty list
FixedSizeList: A list (with correct size) of zero values, which is determined by the element DType
Struct: A struct where each field has a zero value, which is determined by the field DType
Extension: TODO(connor): Is this right? The zero value of the storage DType

Source

pub fn default_value(dtype: &DType) -> Option<Self>

A similar function to ScalarValue::zero_value, but for nullable DTypes, this returns None instead.

For non-nullable and nested types that may need null values in their children (as of right now, that is only FixedSizeList and Struct), this function will provide None as the default child values (whereas ScalarValue::zero_value would provide Some(_)).

Trait Implementations§

Source §

impl Clone for ScalarValue

Source §

fn clone(&self) -> ScalarValue

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

Source §

impl Debug for ScalarValue

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Display for ScalarValue

Source §

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

Formats the value using the given formatter. Read more

Source §