Struct BtrBlocksCompressorBuilder 

pub struct BtrBlocksCompressorBuilder { /* private fields */ }

Builder for creating configured BtrBlocksCompressor instances.

from_session starts from the schemes registered in the session’s CompressionSession, in registration order, and build excludes some of them: by default Zstd and Pco. with_compact and only_cuda_compatible switch to a different preset.

The builder also tracks which serialized array IDs its schemes may produce, taken from the session’s registered arrays and enabled editions. build drops every scheme that produces a disallowed ID.

Examples

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

let session = VortexSession::empty().with::<CompressionSession>();

// Compressor with the session's schemes, restricted to the encodings it allows. This session
// enables no editions, so every scheme is dropped.
let compressor = BtrBlocksCompressorBuilder::from_session(&session).build();

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

Implementations

impl BtrBlocksCompressorBuilder

pub fn from_session(session: &VortexSession) -> Self

Creates a builder with every scheme registered in the session’s CompressionSession, allowing the serialized IDs registered in the session and permitted by its enabled editions.

pub fn empty() -> Self

Creates a builder with no schemes registered.

Useful when the caller wants explicit, scheme-by-scheme control over the compressor. Every added scheme and every serialized ID is allowed.

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

Adds a compression scheme not registered on the session.

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

Switches to the compact preset, keeping Zstd for strings and binary and Pco for numerics.

This provides better compression ratios than the default, especially for floating-point heavy datasets. The Zstd and Pco schemes are only registered with the zstd and pco features.

pub fn only_cuda_compatible(self) -> Self

Switches to the CUDA preset, excluding schemes without CUDA kernel support, keeping FSST for string compression and Zstd for binary compression.

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

Allows serialized IDs the session’s enabled editions do not permit, still requiring them to be registered in the session.

pub fn unrestricted(self) -> Self

Allows serialized IDs regardless of the session’s registered arrays and enabled editions.

Serialized IDs excluded by a preset stay excluded.

pub fn build(self) -> BtrBlocksCompressor

Builds the configured BtrBlocksCompressor from the schemes that its preset does not exclude and whose produced serialized IDs are all allowed.

Trait Implementations

impl Clone for BtrBlocksCompressorBuilder

fn clone(&self) -> Self

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.