Struct actix_web::http::header::Accept

pub struct Accept(pub Vec<QualityItem<Mime>>);

Accept header, defined in RFC7231

The Accept header field can be used by user agents to specify response media types that are acceptable. Accept header fields can be used to indicate that the request is specifically limited to a small set of desired types, as in the case of a request for an in-line image

ABNF

Accept = #( media-range [ accept-params ] )

media-range    = ( "*/*"
                 / ( type "/" "*" )
                 / ( type "/" subtype )
                 ) *( OWS ";" OWS parameter )
accept-params  = weight *( accept-ext )
accept-ext = OWS ";" OWS token [ "=" ( token / quoted-string ) ]

Example values

• audio/*; q=0.2, audio/basic
• text/plain; q=0.5, text/html, text/x-dvi; q=0.8, text/x-c

Examples

use actix_web::HttpResponse;
use actix_web::http::header::{Accept, qitem};

let mut builder = HttpResponse::Ok();
builder.insert_header(
    Accept(vec![
        qitem(mime::TEXT_HTML),
    ])
);

use actix_web::HttpResponse;
use actix_web::http::header::{Accept, qitem};

let mut builder = HttpResponse::Ok();
builder.insert_header(
    Accept(vec![
        qitem(mime::APPLICATION_JSON),
    ])
);

use actix_web::HttpResponse;
use actix_web::http::header::{Accept, QualityItem, q, qitem};

let mut builder = HttpResponse::Ok();
builder.insert_header(
    Accept(vec![
        qitem(mime::TEXT_HTML),
        qitem("application/xhtml+xml".parse().unwrap()),
        QualityItem::new(
            mime::TEXT_XML,
            q(900)
        ),
        qitem("image/webp".parse().unwrap()),
        QualityItem::new(
            mime::STAR_STAR,
            q(800)
        ),
    ])
);

Implementations

impl Accept

pub fn star() -> Accept

Construct Accept: */*.

pub fn json() -> Accept

Construct Accept: application/json.

pub fn text() -> Accept

Construct Accept: text/*.

pub fn image() -> Accept

Construct Accept: image/*.

pub fn html() -> Accept

Construct Accept: text/html.

pub fn mime_precedence(&self) -> Vec<Mime>

Returns a sorted list of mime types from highest to lowest preference, accounting for q-factor weighting and specificity.

pub fn mime_preference(&self) -> Option<Mime>

Extracts the most preferable mime type, accounting for q-factor weighting.

If no q-factors are provided, the first mime type is chosen. Note that items without q-factors are given the maximum preference value.

Returns None if contained list is empty.

Trait Implementations

impl Clone for Accept

fn clone(&self) -> Accept

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Accept

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

Formats the value using the given formatter.

impl Deref for Accept

type Target = Vec<QualityItem<Mime>>

The resulting type after dereferencing.

fn deref(&self) -> &Vec<QualityItem<Mime>>

Dereferences the value.

impl DerefMut for Accept

fn deref_mut(&mut self) -> &mut Vec<QualityItem<Mime>>

Mutably dereferences the value.

impl Display for Accept

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

Formats the value using the given formatter.

impl Header for Accept

fn name() -> HeaderName

Returns the name of the header field

fn parse<T>(msg: &T) -> Result<Self, ParseError> where
    T: HttpMessage, 

Parse a header

impl IntoHeaderValue for Accept

type Error = InvalidHeaderValue

The type returned in the event of a conversion error.

fn try_into_value(self) -> Result<HeaderValue, Self::Error>

Try to convert value to a HeaderValue.

impl PartialEq<Accept> for Accept

fn eq(&self, other: &Accept) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Accept) -> bool

This method tests for !=.

impl StructuralPartialEq for Accept