Crate vortex_layout 

Layout trees, layout readers, scan planning, and segment IO.

A Layout is the serialized, row-counted representation of an array tree. It records logical dtype, child layout relationships, segment ids, and encoding metadata; it does not own the segment bytes. A LayoutReader pairs a layout with a SegmentSource and session so scans can evaluate projections and filters.

Most users enter this crate through file APIs, but extension authors implement VTable, LayoutEncoding, and LayoutStrategy to add new on-disk organizations.

Scanning is built with scan::scan_builder::ScanBuilder. It accepts a projection expression, optional filter, optional row range, Selection, split strategy, and task concurrency settings, then produces array streams or iterators.

Re-exports

pub use vtable::*;

Modules

aliases

display

layouts

A collection of built-in layouts for Vortex

scan

segments

Segment access abstractions for layouts.

sequence

session

vtable

Macros

vtable

Structs

LayoutAdapter

LayoutEncodingAdapter

Object-safe adapter from a typed layout VTable to LayoutEncoding.

LayoutReaderContext

Per-reader-tree dependency context, threaded through crate::VTable::new_reader.

LazyReaderChildren

Lazily constructs and caches child readers while preserving reader context.

RowSplits

A collection of root-coordinate row split points.

SplitRange

A row range used when registering natural scan splits.

Enums

LayoutChildType

A type that allows us to identify how a layout child relates to its parent.

Traits

ArrayFutureExt

Helpers for futures that resolve to arrays.

IntoLayout

Conversion into an erased LayoutRef.

Layout

Erased layout tree node.

LayoutChildren

Abstract way of accessing the children of a layout.

LayoutEncoding

Object-safe layout encoding registered in a LayoutSession.

LayoutReader

Stateful reader for a crate::Layout.

LayoutStrategy

Writes an ordered array stream into a layout tree and segment sink.

Functions

layout_from_flatbuffer

Parse a LayoutRef from a layout flatbuffer.

layout_from_flatbuffer_with_options

Parse a LayoutRef from a layout flatbuffer with unknown-encoding behavior control.

Type Aliases

ArrayFuture

Future resolving to a projected Vortex array.

LayoutContext

LayoutEncodingId

A unique identifier for a layout encoding.

LayoutEncodingRef

Shared reference to a registered layout encoding.

LayoutId

A unique identifier for a layout encoding.

LayoutReaderRef

Shared handle to a stateful layout reader.

LayoutRef

Shared, erased handle to a layout tree node.