Struct StructScalar

pub struct StructScalar<'a> { /* private fields */ }

A scalar value representing a struct with named fields.

This type provides a view into a struct scalar value, which can contain named fields with different types, or be null.

Implementations

impl<'a> StructScalar<'a>

pub fn dtype(&self) -> &'a DType

Returns the data type of this struct scalar.

pub fn struct_fields(&self) -> &StructFields

Returns the struct field definitions.

pub fn names(&self) -> &FieldNames

Returns the field names of the struct.

pub fn is_null(&self) -> bool

Returns true if the struct is null.

pub fn field(&self, name: impl AsRef<str>) -> Option<Scalar>

Returns the field with the given name as a scalar.

Returns None if the field doesn’t exist.

pub fn field_by_idx(&self, idx: usize) -> Option<Scalar>

Returns the field at the given index as a scalar.

Returns None if the index is out of bounds.

Panics

Panics if the struct is null.

pub fn fields(&self) -> Option<Vec<Scalar>>

Returns the fields of the struct scalar, or None if the scalar is null.

pub fn cast(&self, dtype: &DType) -> VortexResult<Scalar>

Casts this struct scalar to another struct type.

Errors

Returns an error if the target type is not a struct or if the number of fields don’t match.

pub fn project(&self, projection: &[FieldName]) -> VortexResult<Scalar>

Projects this struct scalar to include only the specified fields.

Errors

Returns an error if the struct cannot be projected or if a field is not found.

Trait Implementations

impl Display for StructScalar<'_>

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

Formats the value using the given formatter.

impl Hash for StructScalar<'_>

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 StructScalar<'_>

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 StructScalar<'_>

Ord is not implemented since it’s undefined for different field DTypes

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<'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 Eq for StructScalar<'_>