Enum Compression 

pub enum Compression {
    Plaintext,
    Gzip,
    Zstd,
    Lzma,
}

Compression formats supported for descriptor downloads.

Directory servers can compress responses to reduce bandwidth usage. Clients advertise which formats they support, and the server uses the best mutually supported format.

Compression Comparison

Format	Compression	Speed	Support
Plaintext	None	Fastest	Universal
Gzip	Good	Fast	Universal
Zstd	Better	Faster	Modern Tor
Lzma	Best	Slower	Modern Tor

Example

use stem_rs::descriptor::remote::Compression;

let formats = [Compression::Zstd, Compression::Gzip, Compression::Plaintext];
for fmt in &formats {
    println!("Encoding: {}", fmt.encoding());
}

Variants

Plaintext

No compression (identity encoding).

Data is transferred as-is without any compression. Always supported but uses the most bandwidth.

Gzip

Gzip compression (RFC 1952).

Good compression ratio with fast decompression. Universally supported by all Tor versions.

Zstd

Zstandard compression.

Better compression ratio than gzip with faster decompression. Supported by modern Tor versions (0.3.1+).

Lzma

LZMA compression.

Best compression ratio but slower decompression. Supported by modern Tor versions.

Implementations

impl Compression

pub fn encoding(&self) -> &'static str

Returns the HTTP Accept-Encoding value for this compression format.

This is the string used in HTTP headers to indicate support for this compression format.

Returns

The encoding name as used in HTTP headers.

Example

use stem_rs::descriptor::remote::Compression;

assert_eq!(Compression::Gzip.encoding(), "gzip");
assert_eq!(Compression::Plaintext.encoding(), "identity");

Trait Implementations

impl Clone for Compression

fn clone(&self) -> Compression

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Compression

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

Formats the value using the given formatter.

impl PartialEq for Compression

fn eq(&self, other: &Compression) -> 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 Copy for Compression

impl Eq for Compression

impl StructuralPartialEq for Compression