Struct WriteStrategyBuilder 

pub struct WriteStrategyBuilder { /* private fields */ }

Build a new writer strategy to compress and reorganize chunks of a Vortex file.

Vortex provides an out-of-the-box file writer that optimizes the layout of chunks on-disk, repartitioning and compressing them to strike a balance between size on-disk, bulk decoding performance, and IOPS required to perform an indexed read.

The default pipeline first splits struct columns, repartitions rows into fixed-size row blocks, computes zoned statistics, applies dictionary encoding where useful, coalesces chunks toward segment-sized blocks, compresses arrays, buffers nearby chunks, and finally writes flat leaf layouts.

Implementations

impl WriteStrategyBuilder

pub fn with_row_block_size(self, row_block_size: usize) -> Self

Override the row block size used for row repartitioning and zoned statistics.

Larger blocks reduce footer/statistics overhead. Smaller blocks can improve pruning and random-access locality.

pub fn with_field_writer( self, field: impl Into<FieldPath>, writer: Arc<dyn LayoutStrategy>, ) -> Self

Override the write layout for a specific field somewhere in the nested schema tree.

The field path is matched after the root struct is split into columns. This is useful when a column needs a custom compression/layout policy while the rest of the file uses defaults.

pub fn with_allow_encodings(self, allow_encodings: HashSet<ArrayId>) -> Self

Override the allowed array encodings for normalization.

The flat leaf writer uses this set when deciding whether an existing encoded array can be written as-is or must be normalized before serialization.

pub fn with_flat_strategy(self, flat: Arc<dyn LayoutStrategy>) -> Self

Override the flat layout strategy used for leaf chunks.

By default, this uses FlatLayoutStrategy. This can be used to substitute a custom layout strategy, e.g. one that inlines constant array buffers for GPU reads.

pub fn with_btrblocks_builder(self, builder: BtrBlocksCompressorBuilder) -> Self

Override the default BtrBlocksCompressorBuilder used for compression.

The builder is finalized during build, producing two compressors: one for data (with IntDictScheme excluded) and one for stats.

pub fn with_compressor<C: CompressorPlugin>(self, compressor: C) -> Self

Set the compressor to an opaque CompressorPlugin.

The compressor is used as-is for both data and stats compression. Use this when the compressor is already fully configured and should not be modified by the builder.

pub fn build(self) -> Arc<dyn LayoutStrategy>

Builds the canonical LayoutStrategy implementation, with the configured overrides applied.

Trait Implementations

impl Default for WriteStrategyBuilder

fn default() -> Self

Create a new empty builder. It can be further configured, and then finally built yielding the LayoutStrategy.