Struct CompressedIndex 

pub struct CompressedIndex { /* private fields */ }

Compressed index container with format metadata

Implementations

impl CompressedIndex

pub fn compress(data: &[u8], level: i32) -> Result<Self, CompressionError>

Compress data using zstd compression.

Arguments

• data - The data to compress
• level - Compression level (1-22, where 3 is default)

Examples

use sqry_core::indexing::CompressedIndex;

let data = b"test data";
let compressed = CompressedIndex::compress(data, 3)?;

Errors

Returns CompressionError::Io if zstd fails to create the encoder or if writing to the compressor fails.

pub fn uncompressed(data: &[u8]) -> Self

Create an uncompressed index container (for testing or fallback).

Examples

use sqry_core::indexing::CompressedIndex;

let data = b"test data";
let uncompressed = CompressedIndex::uncompressed(data);

pub fn decompress(&self) -> Result<Vec<u8>, CompressionError>

Decompress the index data.

Examples

use sqry_core::indexing::CompressedIndex;

let data = b"test data";
let compressed = CompressedIndex::compress(data, 3)?;
let decompressed = compressed.decompress()?;
assert_eq!(data, &decompressed[..]);

Errors

Returns CompressionError when decompression exceeds the configured safety limit, when zstd emits an error, or when the resulting size does not match the stored header.

pub fn serialize(&self) -> Vec<u8>

Serialize to on-disk format with header.

Format

• Magic: “SQRY” (4 bytes)
• Version: u32 little-endian (4 bytes)
• Compression: u8 (1 byte)
• Level: i32 little-endian (4 bytes)
• Uncompressed Size: u64 little-endian (8 bytes)
• Data: variable length

Total header size: 21 bytes

pub fn deserialize(data: &[u8]) -> Result<Self, CompressionError>

Deserialize from on-disk format.

Errors

Returns an error if:

• Magic bytes don’t match “SQRY”
• Header is too small
• Version is unsupported
• Compression format is unknown

pub fn compression(&self) -> CompressionFormat

Get the compression format used.

pub fn uncompressed_size(&self) -> u64

Get the uncompressed size.

pub fn compressed_size(&self) -> usize

Get the compressed size (actual data size).

pub fn compression_ratio(&self) -> f64

Get the compression ratio (uncompressed / compressed).

Returns 1.0 for uncompressed data.

Trait Implementations

impl Clone for CompressedIndex

fn clone(&self) -> CompressedIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompressedIndex

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

Formats the value using the given formatter.