Enum ByteCodec 

pub enum ByteCodec {
    None,
    Deflate,
    Gzip,
    Brotli,
    ZstdDict(Arc<ZstdDictionary>),
}

Byte-level compression algorithms used by SecureCompressor.

This is distinct from CompressionStrategy, which operates on serde_json::Value (Layer A). ByteCodec operates on raw bytes after JSON serialization (Layer B).

Codecs other than None require the compression feature.

Breaking change (pre-1.0)

Copy was removed from this enum when ZstdDict was added (it carries an Arc<ZstdDictionary>). Code that relied on implicit copy can use .clone() (one atomic refcount bump for ZstdDict; a no-op for the other variants).

Variants

None

No compression — bytes stored verbatim. Always available.

Deflate

Raw deflate (RFC 1951). Low framing overhead.

Note: raw deflate has no magic header, so codec mismatch during decompression will produce a decoder error rather than a guaranteed clean failure. The codec tag embedded in SecureCompressedData prevents this for in-process round-trips.

Requires feature = "compression".

Gzip

Gzip (RFC 1952). Self-identifying via 1f 8b magic header.

Requires feature = "compression".

Brotli

Brotli. Best ratio for repetitive JSON.

Requires feature = "compression".

ZstdDict(Arc<ZstdDictionary>)

Trained zstd dictionary compression.

A single Arc<ZstdDictionary> is the canonical sharing primitive. The inner Vec<u8> inside crate::compression::zstd::ZstdDictionary is not Arc-wrapped — sharing happens exactly once at this enum level (avoids double indirection). Cloning this variant performs one atomic refcount increment and no allocation.

Equality compares the underlying bytes via Arc<T>: PartialEq where T: PartialEq. When both sides share the same Arc allocation, Arc::ptr_eq provides a fast path.

Requires feature = "compression" on a non-wasm32 target.

Trait Implementations

impl Clone for ByteCodec

fn clone(&self) -> ByteCodec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ByteCodec

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

Formats the value using the given formatter.

impl Default for ByteCodec

fn default() -> ByteCodec

Returns the “default value” for a type.

impl PartialEq for ByteCodec

fn eq(&self, other: &ByteCodec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ByteCodec

impl StructuralPartialEq for ByteCodec