Compressor

Struct Compressor 

Source
pub struct Compressor {
    pub enabled: bool,
    pub threshold_bytes: usize,
    pub compression_type: CompressionType,
}
Expand description

Compression configuration and utilities

Default Configuration:

  • Enabled: true
  • Threshold: 4KB (4096 bytes)
  • Type: Snappy

Implementation Notes:

  • C++ client: 4KB default (recommended)
  • C++ server: 1KB default (too aggressive, causes asymmetry)
  • Java: 8KB default (too conservative, less network savings)
  • Rust: 4KB default (standardized best practice)

Configuration via config file:

[zusnet]
COMPRESS=true                # Enable/disable compression
COMPRESS_THRESHSIZE=4096     # Threshold in bytes (default: 4096)

Fields§

§enabled: bool

Compression enabled

§threshold_bytes: usize

Threshold size in bytes (only compress if data >= this size)

Recommended: 4096 (4KB)

  • Balances compression benefit vs CPU cost
  • Standardized across all implementations
§compression_type: CompressionType

Compression type

Current: Snappy (fast, good compression) Future: QuickLZ support for backward compatibility

Implementations§

Source§

impl Compressor

Source

pub fn new() -> Self

Create a new compressor with default settings

Compression Defaults:

  • Threshold: 4KB (4096 bytes) - Recommended standardized value
  • Type: QuickLZ (default in C++ and Java)
  • Enabled: true

Rationale for 4KB threshold:

  • C++ client default: 4KB
  • C++ server default: 1KB (too aggressive)
  • Java default: 8KB (too conservative)
  • Production recommendation: 4KB balances CPU vs network savings
  • Messages < 4KB compress poorly (low ratio, high CPU cost)
  • Messages >= 4KB show 60-70% compression ratio

Rationale for QuickLZ as default:

  • Matches C++ and Java default algorithm
  • Better compression ratio than Snappy (~70% vs ~60%)
  • Slightly slower than Snappy but more compatible
  • Auto-detection works with existing C++/Java services

See: /Users/junfeiwang/Documents/zus-analysis/compression_defaults_comparison.md

Source

pub fn with_config( enabled: bool, threshold_bytes: usize, compression_type: CompressionType, ) -> Self

Create a compressor with custom settings

Source

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

Compress data if it meets the threshold

Returns (compressed_data, was_compressed)

Source

pub fn decompress(&self, data: &[u8]) -> Result<Bytes>

Decompress data

Auto-detects compression type by checking prefixes:

  • “Snappy\0” (7 bytes) → Snappy format
  • “qlz” (3 bytes) → QuickLZ format
  • Otherwise → Try QuickLZ, fallback to uncompressed if it fails

This matches the C++ and Java auto-detection logic.

Trait Implementations§

Source§

impl Clone for Compressor

Source§

fn clone(&self) -> Compressor

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Compressor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Compressor

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more