Trait LayoutEncoding 

pub trait LayoutEncoding:
    'static
    + Send
    + Sync
    + Debug
    + Sealed {
    // Required methods
    fn as_any(&self) -> &dyn Any;
    fn id(&self) -> LayoutEncodingId;
    fn build(
        &self,
        dtype: &DType,
        row_count: u64,
        metadata: &[u8],
        segment_ids: Vec<SegmentId>,
        children: &dyn LayoutChildren,
        build_ctx: &LayoutBuildContext<'_>,
    ) -> VortexResult<LayoutRef>;
}

Object-safe layout encoding registered in a LayoutSession.

Encoding instances deserialize serialized layout metadata into concrete LayoutRef nodes. New in-tree encodings usually implement VTable and use LayoutEncodingAdapter, while foreign encodings can provide an object-safe implementation directly.

Required Methods

fn as_any(&self) -> &dyn Any

Returns this encoding as Any for downcasting.

fn id(&self) -> LayoutEncodingId

Returns the globally unique encoding id.

fn build( &self, dtype: &DType, row_count: u64, metadata: &[u8], segment_ids: Vec<SegmentId>, children: &dyn LayoutChildren, build_ctx: &LayoutBuildContext<'_>, ) -> VortexResult<LayoutRef>

Build a layout from serialized metadata, segment ids, and children.

Implementations must use build_ctx for session-scoped plugin resolution instead of global registries.

Implementations

impl dyn LayoutEncoding + '_

pub fn is<V: VTable>(&self) -> bool

pub fn as_<V: VTable>(&self) -> &V::Encoding

pub fn as_opt<V: VTable>(&self) -> Option<&V::Encoding>

Trait Implementations

impl AsRef<dyn LayoutEncoding> for ChunkedLayoutEncoding

fn as_ref(&self) -> &dyn LayoutEncoding

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

impl AsRef<dyn LayoutEncoding> for DictLayoutEncoding

fn as_ref(&self) -> &dyn LayoutEncoding

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

impl AsRef<dyn LayoutEncoding> for FlatLayoutEncoding

fn as_ref(&self) -> &dyn LayoutEncoding

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

impl AsRef<dyn LayoutEncoding> for StructLayoutEncoding

fn as_ref(&self) -> &dyn LayoutEncoding

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

impl AsRef<dyn LayoutEncoding> for ZonedLayoutEncoding

fn as_ref(&self) -> &dyn LayoutEncoding

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

impl AsRef<dyn LayoutEncoding> for LegacyStatsLayoutEncoding

fn as_ref(&self) -> &dyn LayoutEncoding

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

impl Display for dyn LayoutEncoding + '_

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

Formats the value using the given formatter.

impl Eq for dyn LayoutEncoding + '_

impl PartialEq for dyn LayoutEncoding + '_

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.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl<V: VTable> LayoutEncoding for LayoutEncodingAdapter<V>