Struct ContentEncoding

pub struct ContentEncoding(/* private fields */);

Content-Encoding header, defined in RFC7231

The Content-Encoding header field indicates what content codings have been applied to the representation, beyond those inherent in the media type, and thus what decoding mechanisms have to be applied in order to obtain data in the media type referenced by the Content-Type header field. Content-Encoding is primarily used to allow a representation’s data to be compressed without losing the identity of its underlying media type.

ABNF

Content-Encoding = 1#content-coding

Example values

• gzip
• br
• zstd

Examples

use headers::ContentEncoding;

let content_enc = ContentEncoding::gzip();

Implementations

impl ContentEncoding

pub fn gzip() -> ContentEncoding

A constructor to easily create a Content-Encoding: gzip header.

pub fn brotli() -> ContentEncoding

A constructor to easily create a Content-Encoding: br header.

pub fn zstd() -> ContentEncoding

A constructor to easily create a Content-Encoding: zstd header.

pub fn contains(&self, coding: impl AsCoding) -> bool

Check if this header contains a given “coding”.

This can be used with these argument types:

• &str

Example

use headers::ContentEncoding;

let content_enc = ContentEncoding::gzip();

assert!(content_enc.contains("gzip"));
assert!(!content_enc.contains("br"));

Trait Implementations

impl Clone for ContentEncoding

fn clone(&self) -> ContentEncoding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContentEncoding

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

Formats the value using the given formatter.

impl Header for ContentEncoding

fn name() -> &'static HeaderName

The name of this header.

fn decode<'i, I>(values: &mut I) -> Result<Self, Error>

where I: Iterator<Item = &'i HeaderValue>,

Decode this type from an iterator of HeaderValues.

fn encode<E: Extend<HeaderValue>>(&self, values: &mut E)

Encode this type to a HeaderMap.