Enum ScalarValue

pub enum ScalarValue {
    Bool(bool),
    Primitive(PValue),
    Buffer(Buffer),
    BufferString(BufferString),
    List(Arc<[ScalarValue]>),
    Null,
}

Represents the internal data of a scalar value. Must be interpreted by wrapping up with a DType to make a Scalar.

Note that these values can be deserialized from JSON or other formats. So a PValue may not have the correct width for what the DType expects. This means primitive values must be cast on-read.

Variants

Bool(bool)

Primitive(PValue)

Buffer(Buffer)

BufferString(BufferString)

List(Arc<[ScalarValue]>)

Null

Implementations

impl ScalarValue

pub fn is_null(&self) -> bool

pub fn is_instance_of(&self, dtype: &DType) -> bool

pub fn as_null(&self) -> VortexResult<()>

pub fn as_bool(&self) -> VortexResult<Option<bool>>

pub fn as_pvalue(&self) -> VortexResult<Option<PValue>>

pub fn as_buffer(&self) -> VortexResult<Option<Buffer>>

pub fn as_buffer_string(&self) -> VortexResult<Option<BufferString>>

pub fn as_list(&self) -> VortexResult<Option<&Arc<[Self]>>>

Trait Implementations

impl Clone for ScalarValue

fn clone(&self) -> ScalarValue

Returns a copy of the value.

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<Buffer> for ScalarValue

fn from(value: Buffer) -> Self

Converts to this type from the input type.

impl From<BufferString> for ScalarValue

fn from(value: BufferString) -> Self

Converts to this type from the input type.

impl From<Bytes> for ScalarValue

fn from(value: Bytes) -> Self

Converts to this type from the input type.

impl<T> From<Option<T>> for ScalarValue

where ScalarValue: From<T>,

fn from(value: Option<T>) -> Self

Converts to this type from the input type.

impl From<String> for ScalarValue

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Vec<Buffer>> for ScalarValue

fn from(value: Vec<Buffer>) -> Self

Converts to this type from the input type.

impl From<Vec<BufferString>> for ScalarValue

fn from(value: Vec<BufferString>) -> Self

Converts to this type from the input type.

impl From<Vec<Bytes>> for ScalarValue

fn from(value: Vec<Bytes>) -> Self

Converts to this type from the input type.

impl From<Vec<String>> for ScalarValue

fn from(value: Vec<String>) -> Self

Converts to this type from the input type.

impl From<Vec<f16>> for ScalarValue

fn from(value: Vec<f16>) -> Self

Converts to this type from the input type.

impl From<Vec<f32>> for ScalarValue

fn from(value: Vec<f32>) -> Self

Converts to this type from the input type.

impl From<Vec<f64>> for ScalarValue

fn from(value: Vec<f64>) -> Self

Converts to this type from the input type.

impl From<Vec<i16>> for ScalarValue

fn from(value: Vec<i16>) -> Self

Converts to this type from the input type.

impl From<Vec<i32>> for ScalarValue

fn from(value: Vec<i32>) -> Self

Converts to this type from the input type.

impl From<Vec<i64>> for ScalarValue

fn from(value: Vec<i64>) -> Self

Converts to this type from the input type.

impl From<Vec<i8>> for ScalarValue

fn from(value: Vec<i8>) -> Self

Converts to this type from the input type.

impl From<Vec<u16>> for ScalarValue

fn from(value: Vec<u16>) -> Self

Converts to this type from the input type.

impl From<Vec<u32>> for ScalarValue

fn from(value: Vec<u32>) -> Self

Converts to this type from the input type.

impl From<Vec<u64>> for ScalarValue

fn from(value: Vec<u64>) -> Self

Converts to this type from the input type.

impl From<Vec<usize>> for ScalarValue

fn from(value: Vec<usize>) -> Self

Converts to this type from the input type.

impl From<bool> for ScalarValue

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f16> for ScalarValue

fn from(value: f16) -> Self

Converts to this type from the input type.

impl From<f32> for ScalarValue

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for ScalarValue

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i16> for ScalarValue

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for ScalarValue

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for ScalarValue

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<i8> for ScalarValue

fn from(value: i8) -> Self

Converts to this type from the input type.

impl From<u16> for ScalarValue

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for ScalarValue

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for ScalarValue

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for ScalarValue

fn from(value: u8) -> Self

Converts to this type from the input type.

impl From<usize> for ScalarValue

fn from(value: usize) -> Self

Converts to this type from the input type.

impl PartialEq for ScalarValue

fn eq(&self, other: &ScalarValue) -> 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 ScalarValue

fn partial_cmp(&self, other: &ScalarValue) -> 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 TryFrom<&ScalarValue> for ()

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for Buffer

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for BufferString

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<Buffer>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<BufferString>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<bool>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<f16>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<f32>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<f64>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<i16>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<i32>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<i64>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<i8>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<u16>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<u32>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<u64>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<u8>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for bool

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<&ScalarValue> for f16

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for f32

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for f64

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for i16

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for i32

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for i64

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for i8

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for u16

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for u32

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for u64

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for u8

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for usize

Read a scalar as usize. For usize only, we implicitly cast for better ergonomics.

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for ()

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for Buffer

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for BufferString

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for Option<Buffer>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for Option<BufferString>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for Option<bool>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<ScalarValue> for Option<f16>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for Option<f32>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for Option<f64>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for Option<i16>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for Option<i32>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for Option<i64>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for Option<i8>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for Option<u16>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for Option<u32>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for Option<u64>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for Option<u8>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for bool

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<ScalarValue> for f16

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for f32

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for f64

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for i16

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for i32

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for i64

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for i8

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for u16

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for u32

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for u64

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScalarValue> for u8

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for ScalarValue