Enum CompressAlgorithm

pub enum CompressAlgorithm {
    None,
    Zstd,
}

Compression algorithms available for patch data.

Determines how patch data is compressed before storage or transmission. Different algorithms offer tradeoffs between compression ratio and speed.

Example

use files_diff::{diff, DiffAlgorithm, CompressAlgorithm};

let before = b"original content";
let after = b"modified content";

// Use no compression for debugging or when speed is critical
let uncompressed = diff(
    before,
    after,
    DiffAlgorithm::Rsync020,
    CompressAlgorithm::None
)?;

// Use Zstd for maximum compression
let compressed = diff(
    before,
    after,
    DiffAlgorithm::Rsync020,
    CompressAlgorithm::Zstd
)?;

Variants

None

No compression. Patch data is stored as-is. Use this when:

• Debugging patches
• Working with already compressed data
• Speed is more important than size

Zstd

Zstandard compression with level 21 (maximum compression). Use this when:

• Minimizing patch size is critical
• Network bandwidth or storage is limited
• Compression time is not a concern

Implementations

impl CompressAlgorithm

pub fn compress(self, input: &[u8]) -> Result<Vec<u8>, Error>

Compresses the input data using the selected algorithm.

Trait Implementations

impl Archive for CompressAlgorithm

type Archived = ArchivedCompressAlgorithm

The archived representation of this type.

type Resolver = CompressAlgorithmResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output.

const COPY_OPTIMIZATION: CopyOptimization<Self> = _

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

impl Clone for CompressAlgorithm

fn clone(&self) -> CompressAlgorithm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompressAlgorithm

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

Formats the value using the given formatter.

impl<__D: Fallible + ?Sized> Deserialize<CompressAlgorithm, __D> for Archived<CompressAlgorithm>

fn deserialize( &self, deserializer: &mut __D, ) -> Result<CompressAlgorithm, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl Display for CompressAlgorithm

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

Formats the value using the given formatter.

impl Hash for CompressAlgorithm

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CompressAlgorithm

fn eq(&self, other: &CompressAlgorithm) -> 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<__S: Fallible + ?Sized> Serialize<__S> for CompressAlgorithm

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl Copy for CompressAlgorithm

impl Eq for CompressAlgorithm

impl StructuralPartialEq for CompressAlgorithm