Enum Encoding 

pub enum Encoding {
    Identity,
    Gzip,
    Deflate,
    Zstd,
}

A per-message compression codec. Which variants exist depends on the enabled Cargo features; Identity (no compression) is always present.

Variants

Identity

No compression.

Gzip

Available on crate feature gzip only.

gzip (flate2), enabled by the gzip feature.

Deflate

Available on crate feature deflate only.

raw DEFLATE (flate2), enabled by the deflate feature.

Zstd

Available on crate feature zstd only.

Zstandard (zstd), enabled by the zstd feature.

Implementations

impl Encoding

pub const ALL: &'static [Self]

Every codec compiled into this build, including Identity. Order is the order presented in grpc-accept-encoding.

pub fn from_grpc_encoding(s: &str) -> Option<Self>

Parse a single grpc-encoding token. Returns None for codecs not compiled in or values outside the spec set.

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

The grpc-encoding token for this codec ("identity", "gzip", …).

pub fn accepted_encodings() -> &'static str

Comma-separated list of every codec in this build, suitable for the grpc-accept-encoding response header. Memoized — the value is constant for a given build.

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

Compress data with this codec. Identity returns a copy.

pub fn decompress( &self, data: &[u8], max_size: usize, ) -> Result<Vec<u8>, Status>

Decompress data with this codec, capping the decompressed size at max_size bytes (zip-bomb defense). Identity returns a copy and errors if data.len() > max_size.

Trait Implementations

impl Clone for Encoding

fn clone(&self) -> Encoding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Encoding

impl Debug for Encoding

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

Formats the value using the given formatter.

impl Eq for Encoding

impl Hash for Encoding

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 Encoding

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