Struct BtrBlocksCompressorBuilder 

pub struct BtrBlocksCompressorBuilder { /* private fields */ }

Builder for creating configured BtrBlocksCompressor instances.

By default, all schemes in ALL_SCHEMES are enabled in a deterministic order. Feature-gated schemes (Pco, Zstd) are not in ALL_SCHEMES and must be added explicitly via with_new_scheme or with_compact when the zstd feature is enabled.

Examples

use vortex_btrblocks::{BtrBlocksCompressorBuilder, Scheme, SchemeExt};
use vortex_btrblocks::schemes::integer::IntDictScheme;

// Default compressor with all schemes in ALL_SCHEMES.
let compressor = BtrBlocksCompressorBuilder::default().build();

// Remove specific schemes.
let compressor = BtrBlocksCompressorBuilder::default()
    .exclude_schemes([IntDictScheme.id()])
    .build();

Implementations

impl BtrBlocksCompressorBuilder

pub fn empty() -> Self

Creates a builder with no schemes registered.

Useful when the caller wants explicit, scheme-by-scheme control over the compressor.

pub fn with_new_scheme(self, scheme: &'static dyn Scheme) -> Self

Adds an external compression scheme not in ALL_SCHEMES.

This allows encoding crates outside of vortex-btrblocks to register their own schemes with the compressor.

Panics

Panics if a scheme with the same SchemeId is already present.

pub fn with_compact(self) -> Self

Adds compact encoding schemes (Zstd for strings and binary, Pco for numerics).

This provides better compression ratios than the default, especially for floating-point heavy datasets. Requires the zstd feature. When the pco feature is also enabled, Pco schemes for integers and floats are included.

Panics

Panics if any of the compact schemes are already present.

pub fn only_cuda_compatible(self) -> Self

Excludes schemes without CUDA kernel support and adds Zstd for string and binary compression.

With the unstable_encodings feature, buffer-level Zstd compression is used which preserves the array buffer layout for zero-conversion GPU decompression. Without it, interleaved Zstd compression is used.

This preset is intended for files that will be decoded by CUDA kernels. It may choose a larger encoded representation than the default compressor.

pub fn exclude_schemes(self, ids: impl IntoIterator<Item = SchemeId>) -> Self

Removes the specified compression schemes by their SchemeId.

pub fn build(self) -> BtrBlocksCompressor

Builds the configured BtrBlocksCompressor.

Trait Implementations

impl Clone for BtrBlocksCompressorBuilder

fn clone(&self) -> BtrBlocksCompressorBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BtrBlocksCompressorBuilder

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

Formats the value using the given formatter.

impl Default for BtrBlocksCompressorBuilder

fn default() -> Self

Returns the “default value” for a type.