Struct ScalarValue

pub struct ScalarValue(/* private fields */);

Represents the internal data of a scalar value. Must be interpreted by wrapping up with a DType to make a super::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. Primitive values should therefore be read using super::PrimitiveScalar which will handle the conversion.

Implementations

impl ScalarValue

pub fn to_protobytes<B: BufMut + Default>(&self) -> B

Serializes the scalar value to Protocol Buffers format.

pub fn from_protobytes(buf: &[u8]) -> VortexResult<Self>

Deserializes a scalar value from Protocol Buffers format.

impl ScalarValue

pub const fn null() -> Self

Creates a null scalar value.

pub fn is_null(&self) -> bool

Returns true if this is a null value.

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

Returns true if this value is compatible with the given data type.

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

Returns scalar as a null value

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

Returns scalar as a boolean value

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

Return scalar as a primitive value. PValues don’t match dtypes but will be castable to the scalars dtype

pub fn as_decimal(&self) -> VortexResult<Option<DecimalValue>>

Returns scalar as a decimal value

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

Returns scalar as a binary buffer

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

Returns scalar as a string buffer

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

Returns scalar as a list value

Trait Implementations

impl Clone for ScalarValue

fn clone(&self) -> ScalarValue

Returns a duplicate 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<&[u8]> for ScalarValue

fn from(value: &[u8]) -> Self

Converts to this type from the input type.

impl From<&ScalarValue> for ScalarValue

fn from(value: &ScalarValue) -> Self

Converts to this type from the input type.

impl From<&str> for ScalarValue

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<Buffer<u8>> for ScalarValue

fn from(value: ByteBuffer) -> 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<DecimalValue> for ScalarValue

fn from(value: DecimalValue) -> Self

Converts to this type from the input type.

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

where T: ScalarType, ScalarValue: From<T>,

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

Converts to this type from the input type.

impl From<PValue> for ScalarValue

fn from(value: PValue) -> 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<u8>>> for ScalarValue

fn from(value: Vec<ByteBuffer>) -> 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<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

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

fn from(value: usize) -> Self

Converts to this type from the input type.

impl<'a> TryFrom<&'a ScalarValue> for ByteBuffer

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(scalar: &'a ScalarValue) -> VortexResult<Self>

Performs the conversion.

impl<'a> TryFrom<&'a ScalarValue> for BufferString

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(scalar: &'a ScalarValue) -> VortexResult<Self>

Performs the conversion.

impl<'a> TryFrom<&'a ScalarValue> for Option<ByteBuffer>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(scalar: &'a ScalarValue) -> VortexResult<Self>

Performs the conversion.

impl<'a> TryFrom<&'a ScalarValue> for Option<BufferString>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(scalar: &'a 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 ScalarValue

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<'a> TryFrom<&'a ScalarValue> for String

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a, T: for<'b> TryFrom<&'b ScalarValue, Error = VortexError>> TryFrom<&'a ScalarValue> for Vec<T>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &'a 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.