Struct rocket::http::Accept

pub struct Accept(_);

The HTTP Accept header.

An Accept header is composed of zero or more media types, each of which may have an optional quality value (a QMediaType). The header is sent by an HTTP client to describe the formats it accepts as well as the order in which it prefers different formats.

Usage

The Accept header of an incoming request can be retrieved via the Request::accept method. The preferred method can be used to retrieve the client's preferred media type.

An Accept type with a single, common media type can be easily constructed via provided associated constants.

Example

Construct an Accept header with a single application/json media type:

use rocket::http::Accept;

let accept_json = Accept::JSON;

Header

Accept implements Into<Header>. As such, it can be used in any context where an Into<Header> is expected:

use rocket::http::Accept;
use rocket::response::Response;

let response = Response::build().header(Accept::JSON).finalize();

Methods

impl Accept

pub fn new<T: IntoCollection<QMediaType>>(items: T) -> Accept

Constructs a new Accept header from one or more media types.

The items parameter may be of type QMediaType, &[QMediaType], or Vec<QMediaType>. To prevent additional allocations, prefer to provide inputs of type QMediaType and Vec<QMediaType>.

Example

use rocket::http::{QMediaType, MediaType, Accept};

// Construct an `Accept` via a `Vec<QMediaType>`.
let json_then_html = vec![MediaType::JSON.into(), MediaType::HTML.into()];
let accept = Accept::new(json_then_html);
assert_eq!(accept.preferred().media_type(), &MediaType::JSON);

// Construct an `Accept` via an `&[QMediaType]`.
let accept = Accept::new(&[MediaType::JSON.into(), MediaType::HTML.into()]);
assert_eq!(accept.preferred().media_type(), &MediaType::JSON);

// Construct an `Accept` via a `QMediaType`.
let accept = Accept::new(QMediaType(MediaType::JSON, None));
assert_eq!(accept.preferred().media_type(), &MediaType::JSON);

pub fn preferred(&self) -> &QMediaType

Retrieve the client's preferred media type. This method follows RFC 7231 5.3.2. If the list of media types is empty, this method returns a media type of any with no quality value: (*/*).

Example

use rocket::http::{QMediaType, MediaType, Accept};

let media_types = vec![
    QMediaType(MediaType::JSON, Some(0.3)),
    QMediaType(MediaType::HTML, Some(0.9))
];

let accept = Accept::new(media_types);
assert_eq!(accept.preferred().media_type(), &MediaType::HTML);

pub fn first(&self) -> Option<&QMediaType>

Retrieve the first media type in self, if any.

Example

use rocket::http::{QMediaType, MediaType, Accept};

let accept = Accept::new(QMediaType(MediaType::XML, None));
assert_eq!(accept.first(), Some(&MediaType::XML.into()));

pub fn iter<'a>(     &'a self ) -> impl Iterator<Item = &'a QMediaType> + 'a

Returns an iterator over all of the (quality) media types in self. Media types are returned in the order in which they appear in the header.

Example

use rocket::http::{QMediaType, MediaType, Accept};

let qmedia_types = vec![
    QMediaType(MediaType::JSON, Some(0.3)),
    QMediaType(MediaType::HTML, Some(0.9))
];

let accept = Accept::new(qmedia_types.clone());

let mut iter = accept.iter();
assert_eq!(iter.next(), Some(&qmedia_types[0]));
assert_eq!(iter.next(), Some(&qmedia_types[1]));
assert_eq!(iter.next(), None);

pub fn media_types<'a>(     &'a self ) -> impl Iterator<Item = &'a MediaType> + 'a

Returns an iterator over all of the (bare) media types in self. Media types are returned in the order in which they appear in the header.

Example

use rocket::http::{QMediaType, MediaType, Accept};

let qmedia_types = vec![
    QMediaType(MediaType::JSON, Some(0.3)),
    QMediaType(MediaType::HTML, Some(0.9))
];

let accept = Accept::new(qmedia_types.clone());

let mut iter = accept.media_types();
assert_eq!(iter.next(), Some(qmedia_types[0].media_type()));
assert_eq!(iter.next(), Some(qmedia_types[1].media_type()));
assert_eq!(iter.next(), None);

pub const Any: Accept

An Accept header with the single media type for any media type :

/

pub const Binary: Accept

An Accept header with the single media type for binary data : application / octet-stream

pub const HTML: Accept

An Accept header with the single media type for HTML : text / html

pub const Plain: Accept

An Accept header with the single media type for plain text : text / plain

pub const JSON: Accept

An Accept header with the single media type for JSON : application / json

pub const MsgPack: Accept

An Accept header with the single media type for MessagePack : application / msgpack

pub const Form: Accept

An Accept header with the single media type for forms : application / x-www-form-urlencoded

pub const JavaScript: Accept

An Accept header with the single media type for JavaScript : application / javascript

pub const CSS: Accept

An Accept header with the single media type for CSS : text / css

pub const FormData: Accept

An Accept header with the single media type for multipart form data : multipart / form-data

pub const XML: Accept

An Accept header with the single media type for XML : text / xml

pub const CSV: Accept

An Accept header with the single media type for CSV : text / csv

pub const PNG: Accept

An Accept header with the single media type for PNG : image / png

pub const GIF: Accept

An Accept header with the single media type for GIF : image / gif

pub const BMP: Accept

An Accept header with the single media type for BMP : image / bmp

pub const JPEG: Accept

An Accept header with the single media type for JPEG : image / jpeg

pub const WEBP: Accept

An Accept header with the single media type for WEBP : image / webp

pub const SVG: Accept

An Accept header with the single media type for SVG : image / svg+xml

pub const WEBM: Accept

An Accept header with the single media type for WEBM : video / webm

pub const OGG: Accept

An Accept header with the single media type for OGG : video / ogg

pub const WAV: Accept

An Accept header with the single media type for WAV : audio / wav

pub const PDF: Accept

An Accept header with the single media type for PDF : application / pdf

pub const TTF: Accept

An Accept header with the single media type for TTF : application / font-sfnt

pub const OTF: Accept

An Accept header with the single media type for OTF : application / font-sfnt

pub const WOFF: Accept

An Accept header with the single media type for WOFF : application / font-woff

pub const WOFF2: Accept

An Accept header with the single media type for WOFF2 : font / woff2

pub const WASM: Accept

An Accept header with the single media type for WASM : application / wasm

pub const JsonApi: Accept

An Accept header with the single media type for JSON API : application / vnd.api+json

Trait Implementations

impl<'a, 'r> FromRequest<'a, 'r> for &'a Accept

type Error = ()

The associated error to be returned if derivation fails.

fn from_request(request: &'a Request<'r>) -> Outcome<Self, Self::Error>

Derives an instance of Self from the incoming request metadata.

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 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<T: IntoCollection<MediaType>> From<T> for Accept

fn from(items: T) -> Accept

Performs the conversion.

impl Into<Header<'static>> for Accept

Creates a new Header with name Accept and the value set to the HTTP rendering of this Accept header.

fn into(self) -> Header<'static>

Performs the conversion.

impl Display for Accept

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

Formats the value using the given formatter.

impl Debug for Accept

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

Formats the value using the given formatter.

impl FromStr for Accept

type Err = String

The associated error which can be returned from parsing.

fn from_str(raw: &str) -> Result<Accept, String>

Parses a string s to return a value of this type.