Skip to main content

CompressionAlgorithm

Enum CompressionAlgorithm 

Source
pub enum CompressionAlgorithm {
    Zstd,
    Lz4,
    Gzip,
    Deflate,
    Snappy,
    Identity,
}
Expand description

A supported value of the grpc-encoding header.

Variants§

§

Zstd

Zstandard frames, compressed at level 1.

§

Lz4

LZ4 frames.

§

Gzip

RFC 1952 gzip streams.

§

Deflate

RFC 1950 zlib-wrapped deflate streams.

§

Snappy

Snappy raw blocks.

§

Identity

Uncompressed bytes.

Implementations§

Source§

impl CompressionAlgorithm

Source

pub const fn as_str(self) -> &'static str

The lowercase wire token used in gRPC encoding headers.

Source

pub fn from_encoding(encoding: &str) -> Result<CompressionAlgorithm, Status>

Parses an exact, case-sensitive gRPC encoding token.

§Errors

Returns Unimplemented for an unsupported encoding.

Source

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

Compresses a complete message without applying the adaptive threshold.

§Errors

Returns Internal if a compressor fails.

Source

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

Decodes a message with a strict limit on the returned byte count.

Streaming decoders read at most one byte beyond the limit and never reserve output memory from an untrusted advertised decompressed size. Zstd’s decoding window is capped at 16 MiB independently of this limit; LZ4 frame blocks are bounded by the format’s 4 MiB maximum.

§Errors

Returns ResourceExhausted if output exceeds max_size, or Internal if the compressed stream is malformed.

Trait Implementations§

Source§

impl Clone for CompressionAlgorithm

Source§

fn clone(&self) -> CompressionAlgorithm

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for CompressionAlgorithm

Source§

impl Debug for CompressionAlgorithm

Source§

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

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

impl Default for CompressionAlgorithm

Source§

fn default() -> CompressionAlgorithm

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

impl Eq for CompressionAlgorithm

Source§

impl FromStr for CompressionAlgorithm

Source§

type Err = Status

The associated error which can be returned from parsing.
Source§

fn from_str( value: &str, ) -> Result<CompressionAlgorithm, <CompressionAlgorithm as FromStr>::Err>

Parses a string s to return a value of this type. Read more
Source§

impl PartialEq for CompressionAlgorithm

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CompressionAlgorithm

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, 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.