Trait IntoCanonical

pub trait IntoCanonical {
    // Required method
    fn into_canonical(self) -> VortexResult<Canonical>;

    // Provided methods
    fn into_arrow(self) -> VortexResult<ArrayRef>
       where Self: Sized { ... }
    fn into_arrow_with_data_type(
        self,
        data_type: &DataType,
    ) -> VortexResult<ArrayRef>
       where Self: Sized { ... }
}

Support trait for transmuting an array into the canonical encoding for its vortex_dtype::DType.

This conversion ensures that the array’s encoding matches one of the builtin canonical encodings, each of which has a corresponding Canonical variant.

Invariants

The DType of the array will be unchanged by canonicalization.

Required Methods

fn into_canonical(self) -> VortexResult<Canonical>

Provided Methods

fn into_arrow(self) -> VortexResult<ArrayRef>

where Self: Sized,

fn into_arrow_with_data_type( self, data_type: &DataType, ) -> VortexResult<ArrayRef>

where Self: Sized,

Implementors

impl IntoCanonical for BoolArray

impl IntoCanonical for ChunkedArray

impl IntoCanonical for ConstantArray

impl IntoCanonical for ExtensionArray

impl IntoCanonical for ListArray

impl IntoCanonical for NullArray

impl IntoCanonical for PrimitiveArray

impl IntoCanonical for SparseArray

impl IntoCanonical for StructArray

impl IntoCanonical for VarBinArray

impl IntoCanonical for VarBinViewArray

impl IntoCanonical for ArrayData

IntoCanonical implementation for Array.

Canonicalizing an array requires potentially decompressing, so this requires a roundtrip through the array’s internal codec.