Trait EncodingVTable

pub trait EncodingVTable:
    'static
    + Sync
    + Send
    + ComputeVTable {
    // Required method
    fn id(&self) -> EncodingId;

    // Provided methods
    fn decode(
        &self,
        parts: &ArrayParts,
        ctx: &ArrayContext,
        _dtype: DType,
        _len: usize,
    ) -> VortexResult<ArrayRef> { ... }
    fn encode(
        &self,
        input: &Canonical,
        _like: Option<&dyn Array>,
    ) -> VortexResult<Option<ArrayRef>> { ... }
}

Dyn-compatible VTable trait for a Vortex array encoding.

This trait provides extension points for arrays to implement various features of Vortex. It is split into multiple sub-traits to make it easier for consumers to break up the implementation, as well as to allow for optional implementation of certain features, for example compute functions.

Required Methods

fn id(&self) -> EncodingId

Return the ID for this encoding implementation.

Provided Methods

fn decode( &self, parts: &ArrayParts, ctx: &ArrayContext, _dtype: DType, _len: usize, ) -> VortexResult<ArrayRef>

fn encode( &self, input: &Canonical, _like: Option<&dyn Array>, ) -> VortexResult<Option<ArrayRef>>

Encode the canonical array into this encoding implementation.

Should error if like is encoded with a different encoding.

Trait Implementations

impl Debug for dyn EncodingVTable + '_

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

Formats the value using the given formatter.

impl Display for dyn EncodingVTable + '_

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

Formats the value using the given formatter.

impl Hash for dyn EncodingVTable + '_

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

Feeds this value into the given Hasher.

impl PartialEq for dyn EncodingVTable + '_

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 Eq for dyn EncodingVTable + '_

Implementors

impl EncodingVTable for BoolEncoding

impl EncodingVTable for ChunkedEncoding

impl EncodingVTable for ConstantEncoding

impl EncodingVTable for ExtensionEncoding

impl EncodingVTable for ListEncoding

impl EncodingVTable for NullEncoding

impl EncodingVTable for PrimitiveEncoding

impl EncodingVTable for StructEncoding

impl EncodingVTable for VarBinEncoding

impl EncodingVTable for VarBinViewEncoding