Struct BtrBlocksCompressor 

pub struct BtrBlocksCompressor(pub CascadingCompressor);

The BtrBlocks-style compressor with all built-in schemes pre-registered.

This is a thin wrapper around CascadingCompressor that provides a default set of compression schemes via BtrBlocksCompressorBuilder.

Examples

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

// Default compressor - all schemes allowed.
let compressor = BtrBlocksCompressor::default();

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

Tuple Fields

0: CascadingCompressor

The underlying cascading compressor.

Implementations

impl BtrBlocksCompressor

pub fn compress(&self, array: &ArrayRef) -> VortexResult<ArrayRef>

Compresses an array using BtrBlocks-inspired compression.

Methods from Deref<Target = CascadingCompressor>

pub fn execution_ctx(&self) -> MutexGuard<'_, RawMutex, ExecutionCtx>

Returns a mutable borrow of the execution context.

pub fn compress(&self, array: &ArrayRef) -> Result<ArrayRef, VortexError>

Compresses an array using cascading adaptive compression.

First canonicalizes and compacts the array, then applies optimal compression schemes.

Errors

Returns an error if canonicalization or compression fails.

pub fn compress_child( &self, child: &ArrayRef, parent_ctx: &CompressorContext, parent_id: SchemeId, child_index: usize, ) -> Result<ArrayRef, VortexError>

Compresses a child array produced by a cascading scheme.

If the cascade budget is exhausted, the canonical array is returned as-is. Otherwise, the child context is created by descending and recording the parent scheme + child index, and compression proceeds normally.

Errors

Returns an error if compression fails.

Trait Implementations

impl Clone for BtrBlocksCompressor

fn clone(&self) -> BtrBlocksCompressor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for BtrBlocksCompressor

fn default() -> Self

Returns the “default value” for a type.

impl Deref for BtrBlocksCompressor

type Target = CascadingCompressor

The resulting type after dereferencing.

fn deref(&self) -> &CascadingCompressor

Dereferences the value.