Struct Scalar

pub struct Scalar { /* private fields */ }

A single logical item, composed of both a ScalarValue and a logical DType.

A ScalarValue is opaque, and should be accessed via one of the type-specific scalar wrappers for example BoolScalar, PrimitiveScalar, etc.

Note that PartialOrd is implemented only for an exact match of the scalar’s dtype, including nullability. When the DType does match, ordering is nulls first (lowest), then the natural ordering of the scalar value.

Implementations

impl Scalar

pub fn binary( buffer: impl Into<Arc<ByteBuffer>>, nullability: Nullability, ) -> Self

impl Scalar

pub fn bool(value: bool, nullability: Nullability) -> Self

impl Scalar

pub fn decimal( value: DecimalValue, decimal_type: DecimalDType, nullability: Nullability, ) -> Self

impl Scalar

pub fn extension(ext_dtype: Arc<ExtDType>, value: Scalar) -> Self

impl Scalar

pub fn list( element_dtype: Arc<DType>, children: Vec<Scalar>, nullability: Nullability, ) -> Self

pub fn list_empty(element_dtype: Arc<DType>, nullability: Nullability) -> Self

impl Scalar

pub fn primitive<T: NativePType + Into<PValue>>( value: T, nullability: Nullability, ) -> Self

pub fn primitive_value( value: PValue, ptype: PType, nullability: Nullability, ) -> Self

Create a PrimitiveScalar from a PValue.

Note that an explicit PType is passed since any compatible PValue may be used as the value for a primitive type.

pub fn reinterpret_cast(&self, ptype: PType) -> Self

impl Scalar

pub fn struct_(dtype: DType, children: Vec<Scalar>) -> Self

impl Scalar

pub fn utf8<B>(str: B, nullability: Nullability) -> Self

where B: Into<BufferString>,

pub fn try_utf8<B>( str: B, nullability: Nullability, ) -> Result<Self, <B as TryInto<BufferString>>::Error>

where B: TryInto<BufferString>,

impl Scalar

pub fn new(dtype: DType, value: ScalarValue) -> Self

pub fn dtype(&self) -> &DType

pub fn value(&self) -> &ScalarValue

pub fn into_parts(self) -> (DType, ScalarValue)

pub fn into_value(self) -> ScalarValue

pub fn is_valid(&self) -> bool

pub fn is_null(&self) -> bool

pub fn null(dtype: DType) -> Self

pub fn null_typed<T: ScalarType>() -> Self

pub fn cast(&self, target: &DType) -> VortexResult<Self>

pub fn into_nullable(self) -> Self

pub fn nbytes(&self) -> usize

Size of the scalar in bytes, uncompressed.

impl Scalar

pub fn as_bool(&self) -> BoolScalar<'_>

pub fn as_bool_opt(&self) -> Option<BoolScalar<'_>>

pub fn as_primitive(&self) -> PrimitiveScalar<'_>

pub fn as_primitive_opt(&self) -> Option<PrimitiveScalar<'_>>

pub fn as_decimal(&self) -> DecimalScalar<'_>

pub fn as_decimal_opt(&self) -> Option<DecimalScalar<'_>>

pub fn as_utf8(&self) -> Utf8Scalar<'_>

pub fn as_utf8_opt(&self) -> Option<Utf8Scalar<'_>>

pub fn as_binary(&self) -> BinaryScalar<'_>

pub fn as_binary_opt(&self) -> Option<BinaryScalar<'_>>

pub fn as_struct(&self) -> StructScalar<'_>

pub fn as_struct_opt(&self) -> Option<StructScalar<'_>>

pub fn as_list(&self) -> ListScalar<'_>

pub fn as_list_opt(&self) -> Option<ListScalar<'_>>

pub fn as_extension(&self) -> ExtScalar<'_>

pub fn as_extension_opt(&self) -> Option<ExtScalar<'_>>

Trait Implementations

impl AsRef<Scalar> for Scalar

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Scalar

fn clone(&self) -> Scalar

Returns a duplicate 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

Formats the value using the given formatter.

impl Display for Scalar

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

Formats the value using the given formatter.

impl From<&[u8]> for Scalar

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

Converts to this type from the input type.

impl From<&Scalar> for Scalar

fn from(value: &Scalar) -> Self

Converts to this type from the input type.

impl From<&str> for Scalar

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<Arc<Buffer<u8>>> for Scalar

fn from(value: Arc<ByteBuffer>) -> Self

Converts to this type from the input type.

impl From<Arc<BufferString>> for Scalar

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

Converts to this type from the input type.

impl From<Buffer<u8>> for Scalar

fn from(value: ByteBuffer) -> Self

Converts to this type from the input type.

impl From<BufferString> for Scalar

fn from(value: BufferString) -> Self

Converts to this type from the input type.

impl From<DecimalScalar<'_>> for Scalar

fn from(decimal_scalar: DecimalScalar<'_>) -> Self

Converts to this type from the input type.

impl<T> From<Option<T>> for Scalar

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

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

Converts to this type from the input type.

impl From<PrimitiveScalar<'_>> for Scalar

fn from(pscalar: PrimitiveScalar<'_>) -> Self

Converts to this type from the input type.

impl From<String> for Scalar

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Vec<Buffer<u8>>> for Scalar

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

Converts to this type from the input type.

impl From<Vec<BufferString>> for Scalar

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

Converts to this type from the input type.

impl From<Vec<String>> for Scalar

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

Converts to this type from the input type.

impl From<Vec<f16>> for Scalar

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

Converts to this type from the input type.

impl From<Vec<f32>> for Scalar

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

Converts to this type from the input type.

impl From<Vec<f64>> for Scalar

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

Converts to this type from the input type.

impl From<Vec<i16>> for Scalar

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

Converts to this type from the input type.

impl From<Vec<i32>> for Scalar

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

Converts to this type from the input type.

impl From<Vec<i64>> for Scalar

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

Converts to this type from the input type.

impl From<Vec<i8>> for Scalar

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

Converts to this type from the input type.

impl From<Vec<u16>> for Scalar

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

Converts to this type from the input type.

impl From<Vec<u32>> for Scalar

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

Converts to this type from the input type.

impl From<Vec<u64>> for Scalar

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

Converts to this type from the input type.

impl From<Vec<usize>> for Scalar

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

Converts to this type from the input type.

impl From<bool> for Scalar

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f16> for Scalar

fn from(value: f16) -> Self

Converts to this type from the input type.

impl From<f32> for Scalar

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Scalar

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i16> for Scalar

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Scalar

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Scalar

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Scalar

fn from(value: i8) -> Self

Converts to this type from the input type.

impl From<u16> for Scalar

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Scalar

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Scalar

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Scalar

fn from(value: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Scalar

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 Hash for Scalar

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Scalar

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

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

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(scalar: &Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Scalar> for Arc<dyn Datum>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &Scalar) -> Result<Arc<dyn Datum>, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Scalar> for BinaryScalar<'a>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> TryFrom<&'a Scalar> for BoolScalar<'a>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> TryFrom<&'a Scalar> for DecimalScalar<'a>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(scalar: &'a Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Scalar> for ExtScalar<'a>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> TryFrom<&'a Scalar> for ListScalar<'a>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(scalar: &'a Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Scalar> for Option<bool>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for Option<f16>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for Option<f32>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for Option<f64>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for Option<i16>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for Option<i32>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for Option<i64>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for Option<i8>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for Option<u16>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for Option<u32>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for Option<u64>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for Option<u8>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for Option<usize>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> TryFrom<&'a Scalar> for PrimitiveScalar<'a>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for Scalar

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> TryFrom<&'a Scalar> for String

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> TryFrom<&'a Scalar> for StructScalar<'a>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> TryFrom<&'a Scalar> for Utf8Scalar<'a>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for bool

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for f16

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for f32

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for f64

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for i16

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for i32

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for i64

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for i8

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for u16

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for u32

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for u64

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> for u8

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Scalar> 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: &Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Scalar> for ()

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(scalar: Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Scalar> for ByteBuffer

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(scalar: Scalar) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<Scalar> for BufferString

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(scalar: Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Scalar> for Option<ByteBuffer>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(scalar: Scalar) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<Scalar> for Option<BufferString>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(scalar: Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Scalar> for Option<bool>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for Option<f16>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for Option<f32>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for Option<f64>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for Option<i16>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for Option<i32>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for Option<i64>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for Option<i8>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for Option<u16>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for Option<u32>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for Option<u64>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for Option<u8>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for bool

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for f16

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for f32

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for f64

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for i16

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for i32

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for i64

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for i8

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for u16

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for u32

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for u64

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Scalar> for u8

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for Scalar