Struct ContentEncoding

pub struct ContentEncoding { /* private fields */ }

Specify the compression algorithm.

Specifications

• RFC 7231, section 3.1.2.2: Content-Encoding

Examples

use http_types::Response;
use http_types::content::{ContentEncoding, Encoding};
let mut encoding = ContentEncoding::new(Encoding::Gzip);

let mut res = Response::new(200);
encoding.apply(&mut res);

let encoding = ContentEncoding::from_headers(res)?.unwrap();
assert_eq!(encoding, &Encoding::Gzip);

Implementations

impl ContentEncoding

pub fn new(encoding: Encoding) -> Self

Create a new instance of CacheControl.

pub fn from_headers(headers: impl AsRef<Headers>) -> Result<Option<Self>>

Create a new instance from headers.

pub fn apply(&self, headers: impl AsMut<Headers>)

Sets the Content-Encoding header.

pub fn name(&self) -> HeaderName

Get the HeaderName.

pub fn value(&self) -> HeaderValue

Get the HeaderValue.

pub fn encoding(&self) -> Encoding

Access the encoding kind.

Trait Implementations

impl Debug for ContentEncoding

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

Formats the value using the given formatter.

impl Deref for ContentEncoding

type Target = Encoding

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for ContentEncoding

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<&Encoding> for ContentEncoding

fn from(encoding: &Encoding) -> Self

Converts to this type from the input type.

impl From<&EncodingProposal> for ContentEncoding

fn from(encoding: &EncodingProposal) -> Self

Converts to this type from the input type.

impl From<Encoding> for ContentEncoding

fn from(encoding: Encoding) -> Self

Converts to this type from the input type.

impl From<EncodingProposal> for ContentEncoding

fn from(encoding: EncodingProposal) -> Self

Converts to this type from the input type.

impl PartialEq<&Encoding> for ContentEncoding

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 PartialEq<Encoding> for ContentEncoding

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 ToHeaderValues for ContentEncoding

type Iter = IntoIter<HeaderValue>

Returned iterator over header values which this type may correspond to.

fn to_header_values(&self) -> Result<Self::Iter>

Converts this object to an iterator of resolved HeaderValues.