Struct ScpStorageCompressionPipeline 

pub struct ScpStorageCompressionPipeline { /* private fields */ }

A configurable multi-stage data compression pipeline.

Each stage can independently apply an algorithm (RLE, LZ77, Delta, XOR) to the running data buffer, or be skipped based on size thresholds.

Thread safety

This type is Send + Sync. Statistics are guarded by a parking_lot::Mutex.

Implementations

impl ScpStorageCompressionPipeline

pub fn new(config: ScpPipelineConfig) -> Self

Create a new pipeline with the given configuration.

Returns ScpPipelineError::InvalidConfiguration if any stage has an XOR algorithm with an empty key.

pub fn compress(&self, data: &[u8]) -> Result<CompressedBlock, ScpPipelineError>

Compress data through all configured stages in order.

Stages that are disabled or whose min_size_bytes is not met are transparently skipped. When enable_checksum is set, an 8-byte FNV-1a-64 checksum is appended to the output payload.

pub fn decompress( &self, block: &CompressedBlock, ) -> Result<Vec<u8>, ScpPipelineError>

Decompress a CompressedBlock produced by this pipeline (or any pipeline with identical stage configuration).

Stages are applied in reverse order using the stages_applied list embedded in the block.

pub fn compress_with_stages( &self, data: &[u8], stages: &[CompressionStage], ) -> Result<CompressedBlock, ScpPipelineError>

Compress data using a custom set of stages instead of those in the pipeline’s configuration.

The max_input_size and enable_checksum settings from the pipeline configuration still apply.

pub fn best_algorithm(&self, data: &[u8]) -> ScpCompressionAlgorithm

Heuristically determine the best single-stage algorithm for data by trying None, Rle, and Lz77 on the first 1024 bytes.

Returns the algorithm that yields the best compression ratio.

pub fn stats(&self) -> ScpPipelineStats

Return a snapshot of the current pipeline statistics.