Struct ajars_surf::surf::http::content::Accept

pub struct Accept { /* private fields */ }

Client header advertising which media types the client is able to understand.

Using content negotiation, the server then selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Browsers set adequate values for this header depending on the context where the request is done: when fetching a CSS stylesheet a different value is set for the request than when fetching an image, video or a script.

MDN Documentation

Specifications

• RFC 7231, section 5.3.2: Accept

Examples

use http_types::content::{Accept, MediaTypeProposal};
use http_types::{mime, Response};

let mut accept = Accept::new();
accept.push(MediaTypeProposal::new(mime::HTML, Some(0.8))?);
accept.push(MediaTypeProposal::new(mime::XML, Some(0.4))?);
accept.push(mime::PLAIN);

let mut res = Response::new(200);
let content_type = accept.negotiate(&[mime::XML])?;
content_type.apply(&mut res);

assert_eq!(res["Content-Type"], "application/xml;charset=utf-8");

Implementations

impl Accept

pub fn new() -> Accept

Create a new instance of Accept.

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

Create an instance of Accept from a Headers instance.

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

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: &[Mime]) -> Result<ContentType, Error>

Determine the most suitable Content-Type 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 Accept

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a Accept

type Item = &'a MediaTypeProposal

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 Accept as IntoIterator>::IntoIter

Creates an iterator from a value.

impl IntoIterator for Accept

type Item = MediaTypeProposal

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

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

type Item = &'a mut MediaTypeProposal

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 Accept as IntoIterator>::IntoIter

Creates an iterator from a value.

impl ToHeaderValues for Accept

type Iter = IntoIter<HeaderValue>

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

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

Converts this object to an iterator of resolved HeaderValues.