Trait LayoutEncoding

pub trait LayoutEncoding:
    Debug
    + Send
    + Sync {
    // Required methods
    fn id(&self) -> LayoutId;
    fn reader(
        &self,
        layout: LayoutData,
        ctx: ContextRef,
        segments: Arc<dyn AsyncSegmentReader>,
    ) -> VortexResult<Arc<dyn LayoutReader>>;
    fn register_splits(
        &self,
        layout: &LayoutData,
        field_mask: &[FieldMask],
        row_offset: u64,
        splits: &mut BTreeSet<u64>,
    ) -> VortexResult<()>;
}

Required Methods

fn id(&self) -> LayoutId

Returns the globally unique ID for this type of layout.

fn reader( &self, layout: LayoutData, ctx: ContextRef, segments: Arc<dyn AsyncSegmentReader>, ) -> VortexResult<Arc<dyn LayoutReader>>

Construct a LayoutReader for the provided LayoutData.

May panic if the provided LayoutData is not the same encoding as this LayoutEncoding.

fn register_splits( &self, layout: &LayoutData, field_mask: &[FieldMask], row_offset: u64, splits: &mut BTreeSet<u64>, ) -> VortexResult<()>

Register the row splits for this layout, these represent natural boundaries at which a reader can split the layout for independent processing.

For example, a ChunkedLayout would register a boundary at the end of every chunk.

The layout is passed a row_offset that identifies the starting row of the layout within the file.

Implementors

impl LayoutEncoding for ChunkedLayout

In-memory representation of Chunked layout.

First child in the list is the metadata table Subsequent children are consecutive chunks of this layout

impl LayoutEncoding for FlatLayout

impl LayoutEncoding for StructLayout