Enum Scalar 

pub enum Scalar {
    Null(NullScalar),
    Bool(BoolScalar),
    Decimal(DecimalScalar),
    Primitive(PrimitiveScalar),
    String(StringScalar),
    Binary(BinaryScalar),
    List(ListViewScalar),
    FixedSizeList(FixedSizeListScalar),
    Struct(StructScalar),
}

Represents a scalar value of any supported type.

Variants

Null(NullScalar)

Null scalars are always null.

Bool(BoolScalar)

Boolean scalars hold the boolean value in an Option, where None represents null.

Decimal(DecimalScalar)

Decimal scalars hold the decimal value in a DScalar, or else None for null.

Primitive(PrimitiveScalar)

Primitive scalars hold the primitive value in a PScalar, or else None for null.

String(StringScalar)

String scalars hold the string data in a BufferString, or else None for null.

Binary(BinaryScalar)

Binary scalars hold the binary data in a ByteBuffer, or else None for null.

List(ListViewScalar)

Variable-size list scalars hold the list elements in a vector, or else None for null.

FixedSizeList(FixedSizeListScalar)

Fixed-size list scalars hold the list elements in a vector, or else None for null.

Struct(StructScalar)

Struct scalars are represented as a length-1 struct vector.

Implementations

impl Scalar

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

Creates a zero/default scalar of the given DType.

For numeric types, this returns 0. For booleans, this returns false. For strings/binary, this returns an empty value. For complex types, this creates a scalar with zero/default elements.

Panics

Panics if the dtype is DType::Null, since null scalars cannot be zero.

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

Creates a null scalar of the given DType.

Panics

Panics if the dtype is not nullable.

pub fn into_null(self) -> NullScalar

Converts the Scalar into a NullScalar.

pub fn into_bool(self) -> BoolScalar

Converts the Scalar into a BoolScalar.

pub fn to_bool(&self) -> &BoolScalar

Converts the Scalar into a BoolScalar.

pub fn into_decimal(self) -> DecimalScalar

Converts the Scalar into a DecimalScalar.

pub fn into_primitive(self) -> PrimitiveScalar

Converts the Scalar into a PrimitiveScalar.

pub fn into_string(self) -> StringScalar

Converts the Scalar into a StringScalar.

pub fn into_binary(self) -> BinaryScalar

Converts the Scalar into a BinaryScalar.

pub fn into_list(self) -> ListViewScalar

Converts the Scalar into a ListViewScalar.

pub fn into_fixed_size_list(self) -> FixedSizeListScalar

Converts the Scalar into a FixedSizeListScalar.

pub fn into_struct(self) -> StructScalar

Converts the Scalar into a StructScalar.

impl Scalar

pub fn as_null(&self) -> &NullScalar

Returns a reference to the inner NullScalar.

pub fn as_bool(&self) -> &BoolScalar

Returns a reference to the inner BoolScalar.

pub fn as_decimal(&self) -> &DecimalScalar

Returns a reference to the inner DecimalScalar.

pub fn as_primitive(&self) -> &PrimitiveScalar

Returns a reference to the inner PrimitiveScalar.

pub fn as_string(&self) -> &StringScalar

Returns a reference to the inner StringScalar.

pub fn as_binary(&self) -> &BinaryScalar

Returns a reference to the inner BinaryScalar.

pub fn as_list(&self) -> &ListViewScalar

Returns a reference to the inner ListViewScalar.

pub fn as_fixed_size_list(&self) -> &FixedSizeListScalar

Returns a reference to the inner FixedSizeListScalar.

pub fn as_struct(&self) -> &StructScalar

Returns a reference to the inner StructScalar.

Trait Implementations

impl BinaryViewTypeUpcast for Scalar

type Input<T: BinaryViewType> = BinaryViewScalar<T>

The input type for upcasting.

fn from_binary(input: Self::Input<BinaryType>) -> Self

Upcast from a binary type.

fn from_string(input: Self::Input<StringType>) -> Self

Upcast from a string 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<T: BinaryViewType> From<BinaryViewScalar<T>> for Scalar

fn from(val: BinaryViewScalar<T>) -> Self

Converts to this type from the input type.

impl From<BoolScalar> for Scalar

fn from(val: BoolScalar) -> Self

Converts to this type from the input type.

impl<D: NativeDecimalType> From<DScalar<D>> for Scalar

fn from(value: DScalar<D>) -> Self

Converts to this type from the input type.

impl From<DecimalScalar> for Scalar

fn from(val: DecimalScalar) -> Self

Converts to this type from the input type.

impl From<FixedSizeListScalar> for Scalar

fn from(val: FixedSizeListScalar) -> Self

Converts to this type from the input type.

impl From<ListViewScalar> for Scalar

fn from(val: ListViewScalar) -> Self

Converts to this type from the input type.

impl From<NullScalar> for Scalar

fn from(val: NullScalar) -> Self

Converts to this type from the input type.

impl<T: NativePType> From<PScalar<T>> for Scalar

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

Converts to this type from the input type.

impl From<PrimitiveScalar> for Scalar

fn from(val: PrimitiveScalar) -> Self

Converts to this type from the input type.

impl From<Scalar> for Datum

fn from(value: Scalar) -> Self

Converts to this type from the input type.

impl From<StructScalar> for Scalar

fn from(val: StructScalar) -> 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 PartialEq for Scalar

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

fn is_valid(&self) -> bool

Returns true if the scalar is valid (not null).

fn mask_validity(&mut self, mask: bool)

Intersect the validity of this scalar with the provided mask value.

fn repeat(&self, n: usize) -> VectorMut

Creates a new vector with n repetitions of this scalar.

fn is_null(&self) -> bool

Returns true if the scalar is null.

impl StructuralPartialEq for Scalar