Struct ajars_surf::surf::http::transfer::TE

pub struct TE { /* private fields */ }

Client header advertising the transfer encodings the user agent is willing to accept.

MDN Documentation

Specifications

• RFC 7230, section 4.3: TE

Examples

use http_types::transfer::{TE, TransferEncoding, Encoding, EncodingProposal};
use http_types::Response;

let mut te = TE::new();
te.push(EncodingProposal::new(Encoding::Brotli, Some(0.8))?);
te.push(EncodingProposal::new(Encoding::Gzip, Some(0.4))?);
te.push(EncodingProposal::new(Encoding::Identity, None)?);

let mut res = Response::new(200);
let encoding = te.negotiate(&[Encoding::Brotli, Encoding::Gzip])?;
encoding.apply(&mut res);

assert_eq!(res["Content-Encoding"], "br");

Implementations

impl TE

pub fn new() -> TE

Create a new instance of TE.

pub fn from_headers(headers: impl AsRef<Headers>) -> Result<Option<TE>, Error>

Create an instance of TE from a Headers instance.

pub fn push(&mut self, prop: impl Into<EncodingProposal>)

Push a directive into the list of entries.

pub fn wildcard(&self) -> bool

Returns true if a wildcard directive was passed.

pub fn set_wildcard(&mut self, wildcard: bool)

Set the wildcard directive.

pub fn sort(&mut self)

Sort the header directives by weight.

Headers with a higher q= value will be returned first. If two directives have the same weight, the directive that was declared later will be returned first.

pub fn negotiate(
    &mut self,
    available: &[Encoding]
) -> Result<TransferEncoding, Error>

Determine the most suitable Transfer-Encoding encoding.

Errors

If no suitable encoding is found, an error with the status of 406 will be returned.

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

Sets the Accept-Encoding header.

pub fn name(&self) -> HeaderName

Get the HeaderName.

pub fn value(&self) -> HeaderValue

Get the HeaderValue.

pub fn iter(&self) -> Iter<'_>

An iterator visiting all entries.

pub fn iter_mut(&mut self) -> IterMut<'_>

An iterator visiting all entries.

Trait Implementations

impl Debug for TE

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a mut TE

type Item = &'a mut EncodingProposal

The type of the elements being iterated over.

type IntoIter = IterMut<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a mut TE as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a TE

type Item = &'a EncodingProposal

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a TE as IntoIterator>::IntoIter

Creates an iterator from a value.

impl IntoIterator for TE

type Item = EncodingProposal

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> <TE as IntoIterator>::IntoIter

Creates an iterator from a value.

impl ToHeaderValues for TE

type Iter = IntoIter<HeaderValue>

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

fn to_header_values(&self) -> Result<<TE as ToHeaderValues>::Iter, Error>

Converts this object to an iterator of resolved HeaderValues.