Struct ContentEncoding 

pub struct ContentEncoding(pub NonEmptyVec<ContentEncodingDirective>);

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
• deflate, gzip

Examples

use rama_http_headers::ContentEncoding;

let content_enc = ContentEncoding::gzip();

Tuple Fields

0: NonEmptyVec<ContentEncodingDirective>

Implementations

impl ContentEncoding

pub fn new(value: ContentEncodingDirective) -> ContentEncoding

impl ContentEncoding

pub fn new_multi( directives: NonEmptyVec<ContentEncodingDirective>, ) -> ContentEncoding

Create a new ContentEncoding header with multiple directives.

Meaning the content is encoded with all given directives and in order.

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_directive(&self, coding: impl CmpCoding) -> bool

Check if this header contains a given “coding”.

This can be used with these argument types:

• &str

Example

use rama_http_headers::ContentEncoding;

let content_enc = ContentEncoding::gzip();

assert!(content_enc.contains_directive("gzip"));
assert!(!content_enc.contains_directive("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<(), Error>

Formats the value using the given formatter.

impl HeaderDecode for ContentEncoding

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

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

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for ContentEncoding

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

where E: Extend<HeaderValue>,

Encode this type to a HeaderValue, and add it to a container which has HeaderValue type as each element.

fn encode_to_value(&self) -> Option<HeaderValue>

Encode this header to HeaderValue.

impl TypedHeader for ContentEncoding

fn name() -> &'static HeaderName

The name of this header.