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.

Implementations

impl WriteStrategyBuilder

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

Override the compressor used for compressing chunks in the file.

If not provided, this will use a BtrBlocks-style cascading compressor that tries to balance total size with decoding performance.

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

Override the row block size used to determine the zone map sizes.

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

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

pub fn with_allow_encodings(self, allow_encodings: ArrayRegistry) -> Self

Override the allowed array encodings for normalization.

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_cuda_compatible_encodings(self) -> Self

Configure a write strategy that emits only CUDA-compatible encodings.

This configures BtrBlocks to exclude schemes without CUDA kernel support. With the unstable_encodings feature, strings use buffer-level Zstd compression (ZstdBuffersArray) which preserves the array buffer layout for zero-conversion GPU decompression. Without it, strings use interleaved Zstd compression.

pub fn with_compact_encodings(self) -> Self

Configure a write strategy that uses compact encodings (Pco for numerics, Zstd for strings/binary).

This provides better compression ratios than the default BtrBlocks strategy, especially for floating-point heavy datasets.

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.