Struct rocket::http::Accept

source ·
pub struct Accept(_);
Expand description

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;

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();

Implementations§

source§

impl Accept

source

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

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

The items parameter may be of type QMediaType, [QMediaType], &[QMediaType] or Vec<QMediaType>. To prevent additional allocations, prefer to provide inputs of type QMediaType, [QMediaType], or 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);
source

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);
source

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()));
source

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

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);
source

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

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);
source

pub const Any: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::Any, None)))

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

/

source

pub const Binary: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::Binary, None)))

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

source

pub const Bytes: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::Bytes, None)))

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

source

pub const HTML: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::HTML, None)))

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

source

pub const Plain: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::Plain, None)))

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

source

pub const Text: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::Text, None)))

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

source

pub const JSON: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::JSON, None)))

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

source

pub const MsgPack: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::MsgPack, None)))

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

source

pub const Form: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::Form, None)))

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

source

pub const JavaScript: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::JavaScript, None)))

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

source

pub const CSS: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::CSS, None)))

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

source

pub const FormData: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::FormData, None)))

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

source

pub const XML: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::XML, None)))

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

source

pub const OPF: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::OPF, None)))

An Accept header with the single media type for OPF : application / oebps-package+xml

source

pub const XHTML: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::XHTML, None)))

An Accept header with the single media type for XHTML : application / xhtml+xml

source

pub const CSV: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::CSV, None)))

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

source

pub const PNG: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::PNG, None)))

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

source

pub const GIF: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::GIF, None)))

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

source

pub const BMP: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::BMP, None)))

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

source

pub const JPEG: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::JPEG, None)))

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

source

pub const WEBP: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::WEBP, None)))

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

source

pub const AVIF: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::AVIF, None)))

An Accept header with the single media type for AVIF : image / avif

source

pub const SVG: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::SVG, None)))

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

source

pub const Icon: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::Icon, None)))

An Accept header with the single media type for Icon : image / x-icon

source

pub const WEBM: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::WEBM, None)))

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

source

pub const WEBA: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::WEBA, None)))

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

source

pub const OGG: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::OGG, None)))

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

source

pub const FLAC: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::FLAC, None)))

An Accept header with the single media type for FLAC : audio / flac

source

pub const WAV: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::WAV, None)))

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

source

pub const PDF: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::PDF, None)))

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

source

pub const TTF: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::TTF, None)))

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

source

pub const OTF: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::OTF, None)))

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

source

pub const WOFF: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::WOFF, None)))

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

source

pub const WOFF2: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::WOFF2, None)))

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

source

pub const JsonApi: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::JsonApi, None)))

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

source

pub const WASM: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::WASM, None)))

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

source

pub const TIFF: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::TIFF, None)))

An Accept header with the single media type for TIFF : image / tiff

source

pub const AAC: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::AAC, None)))

An Accept header with the single media type for AAC Audio : audio / aac

source

pub const Calendar: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::Calendar, None)))

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

source

pub const MPEG: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::MPEG, None)))

An Accept header with the single media type for MPEG Video : video / mpeg

source

pub const TAR: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::TAR, None)))

An Accept header with the single media type for tape archive : application / x-tar

source

pub const GZIP: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::GZIP, None)))

An Accept header with the single media type for gzipped binary : application / gzip

source

pub const MOV: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::MOV, None)))

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

source

pub const MP3: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::MP3, None)))

An Accept header with the single media type for MPEG Audio : audio / mpeg

source

pub const MP4: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::MP4, None)))

An Accept header with the single media type for MPEG4 Video : video / mp4

source

pub const ZIP: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::ZIP, None)))

An Accept header with the single media type for ZIP archive : application / zip

source

pub const CBZ: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::CBZ, None)))

An Accept header with the single media type for Comic ZIP archive : application / vnd.comicbook+zip

source

pub const CBR: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::CBR, None)))

An Accept header with the single media type for Comic RAR compressed archive : application / vnd.comicbook-rar

source

pub const RAR: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::RAR, None)))

An Accept header with the single media type for RAR compressed archive : application / vnd.rar

source

pub const EPUB: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::EPUB, None)))

An Accept header with the single media type for EPUB : application / epub+zip

source

pub const EventStream: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::EventStream, None)))

An Accept header with the single media type for SSE stream : text / event-stream

source

pub const Markdown: Accept = Accept(AcceptParams::Static(QMediaType(MediaType::Markdown, None)))

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

Trait Implementations§

source§

impl Clone for Accept

source§

fn clone(&self) -> Accept

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Accept

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for Accept

source§

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

Formats the value using the given formatter. Read more
source§

impl From<Accept> for Header<'static>

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

source§

fn from(val: Accept) -> Header<'static>

Converts to this type from the input type.
source§

impl<T> From<T> for Acceptwhere T: IntoCollection<MediaType>,

source§

fn from(items: T) -> Accept

Converts to this type from the input type.
source§

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

§

type Error = Infallible

The associated error to be returned if derivation fails.
source§

fn from_request<'life0, 'async_trait>( request: &'r Request<'life0> ) -> Pin<Box<dyn Future<Output = Outcome<Self, Self::Error>> + Send + 'async_trait>>where Self: 'async_trait, 'r: 'async_trait, 'life0: 'async_trait,

Derives an instance of Self from the incoming request metadata. Read more
source§

impl FromStr for Accept

§

type Err = String

The associated error which can be returned from parsing.
source§

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

Parses a string s to return a value of this type. Read more
source§

impl PartialEq<Accept> for Accept

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T> AsTaggedExplicit<'a> for Twhere T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self>

§

impl<'a, T> AsTaggedImplicit<'a> for Twhere T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self>

source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoCollection<T> for T

source§

fn into_collection<A>(self) -> SmallVec<A>where A: Array<Item = T>,

Converts self into a collection.
source§

fn mapped<U, F, A>(self, f: F) -> SmallVec<A>where F: FnMut(T) -> U, A: Array<Item = U>,

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more