Struct rocket::http::ContentType

pub struct ContentType(pub MediaType);

Representation of HTTP Content-Types.

Usage

ContentTypes should rarely be created directly. Instead, an associated constant should be used; one is declared for most commonly used content types.

Example

A Content-Type of text/html; charset=utf-8 can be instantiated via the HTML constant:

use rocket::http::ContentType;

let html = ContentType::HTML;

Header

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

use rocket::http::ContentType;
use rocket::response::Response;

let response = Response::build().header(ContentType::HTML).finalize();

Methods

impl ContentType

pub fn new<T, S>(top: T, sub: S) -> ContentType where     T: Into<Cow<'static, str>>,     S: Into<Cow<'static, str>>,

Creates a new ContentType with top-level type top and subtype sub. This should only be used to construct uncommon or custom content types. Use an associated constant for everything else.

Example

Create a custom application/x-person content type:

use rocket::http::ContentType;

let custom = ContentType::new("application", "x-person");
assert_eq!(custom.top(), "application");
assert_eq!(custom.sub(), "x-person");

pub fn from_extension(ext: &str) -> Option<ContentType>

Returns the Content-Type associated with the extension ext if the extension is recognized. Not all extensions are recognized. If an extensions is not recognized, then this method returns None. The currently recognized extensions are txt, html, htm, xml, csv, js, css, json, png, gif, bmp, jpeg, jpg, webp, svg, pdf, ttf, otf, woff, and woff2. Extensions are matched case-insensitively.

Example

Recognized content types:

use rocket::http::ContentType;

let xml = ContentType::from_extension("xml");
assert_eq!(xml, Some(ContentType::XML));

let xml = ContentType::from_extension("XML");
assert_eq!(xml, Some(ContentType::XML));

An unrecognized content type:

use rocket::http::ContentType;

let foo = ContentType::from_extension("foo");
assert!(foo.is_none());

pub fn with_params<T, S, K, V, P>(top: T, sub: S, ps: P) -> ContentType where     T: Into<Cow<'static, str>>,     S: Into<Cow<'static, str>>,     K: Into<Cow<'static, str>>,     V: Into<Cow<'static, str>>,     P: IntoCollection<(K, V)>,

Creates a new ContentType with top-level type top, subtype sub, and parameters ps. This should only be used to construct uncommon or custom content types. Use an associated constant for everything else.

Example

Create a custom application/x-id; id=1 content type:

use rocket::http::ContentType;

let id = ContentType::with_params("application", "x-id", ("id", "1"));
assert_eq!(id.to_string(), "application/x-id; id=1".to_string());

Create a custom text/person; name=bob; weight=175 content type:

use rocket::http::ContentType;

let params = vec![("name", "bob"), ("ref", "2382")];
let mt = ContentType::with_params("text", "person", params);
assert_eq!(mt.to_string(), "text/person; name=bob; ref=2382".to_string());

pub fn media_type(&self) -> &MediaType

Borrows the inner MediaType of self.

Example

use rocket::http::{ContentType, MediaType};

let http = ContentType::HTML;
let media_type = http.media_type();

pub const Any: ContentType

Content-Type for any media type :

/

pub const Binary: ContentType

Content-Type for binary data : application / octet-stream

pub const HTML: ContentType

Content-Type for HTML : text / html ; charset = utf-8

pub const Plain: ContentType

Content-Type for plain text : text / plain ; charset = utf-8

pub const JSON: ContentType

Content-Type for JSON : application / json

pub const MsgPack: ContentType

Content-Type for MessagePack : application / msgpack

pub const Form: ContentType

Content-Type for forms : application / x-www-form-urlencoded

pub const JavaScript: ContentType

Content-Type for JavaScript : application / javascript

pub const CSS: ContentType

Content-Type for CSS : text / css ; charset = utf-8

pub const FormData: ContentType

Content-Type for multipart form data : multipart / form-data

pub const XML: ContentType

Content-Type for XML : text / xml ; charset = utf-8

pub const CSV: ContentType

Content-Type for CSV : text / csv ; charset = utf-8

pub const PNG: ContentType

Content-Type for PNG : image / png

pub const GIF: ContentType

Content-Type for GIF : image / gif

pub const BMP: ContentType

Content-Type for BMP : image / bmp

pub const JPEG: ContentType

Content-Type for JPEG : image / jpeg

pub const WEBP: ContentType

Content-Type for WEBP : image / webp

pub const SVG: ContentType

Content-Type for SVG : image / svg+xml

pub const WEBM: ContentType

Content-Type for WEBM : video / webm

pub const OGG: ContentType

Content-Type for OGG : video / ogg

pub const WAV: ContentType

Content-Type for WAV : audio / wav

pub const PDF: ContentType

Content-Type for PDF : application / pdf

pub const TTF: ContentType

Content-Type for TTF : application / font-sfnt

pub const OTF: ContentType

Content-Type for OTF : application / font-sfnt

pub const WOFF: ContentType

Content-Type for WOFF : application / font-woff

pub const WOFF2: ContentType

Content-Type for WOFF2 : font / woff2

pub const WASM: ContentType

Content-Type for WASM : application / wasm

pub const JsonApi: ContentType

Content-Type for JSON API : application / vnd.api+json

Methods from Deref<Target = MediaType>

pub fn top(&self) -> &UncasedStr

Returns the top-level type for this media type. The return type, UncasedStr, has caseless equality comparison and hashing.

Example

use rocket::http::MediaType;

let plain = MediaType::Plain;
assert_eq!(plain.top(), "text");
assert_eq!(plain.top(), "TEXT");
assert_eq!(plain.top(), "Text");

pub fn sub(&self) -> &UncasedStr

Returns the subtype for this media type. The return type, UncasedStr, has caseless equality comparison and hashing.

Example

use rocket::http::MediaType;

let plain = MediaType::Plain;
assert_eq!(plain.sub(), "plain");
assert_eq!(plain.sub(), "PlaIN");
assert_eq!(plain.sub(), "pLaIn");

pub fn specificity(&self) -> u8

Returns a u8 representing how specific the top-level type and subtype of this media type are.

The return value is either 0, 1, or 2, where 2 is the most specific. A 0 is returned when both the top and sublevel types are *. A 1 is returned when only one of the top or sublevel types is *, and a 2 is returned when neither the top or sublevel types are *.

Example

use rocket::http::MediaType;

let mt = MediaType::Plain;
assert_eq!(mt.specificity(), 2);

let mt = MediaType::new("text", "*");
assert_eq!(mt.specificity(), 1);

let mt = MediaType::Any;
assert_eq!(mt.specificity(), 0);

pub fn exact_eq(&self, other: &MediaType) -> bool

Compares self with other and returns true if self and other are exactly equal to eachother, including with respect to their parameters.

This is different from the PartialEq implementation in that it considers parameters. If PartialEq returns false, this function is guaranteed to return false. Similarly, if this function returns true, PartialEq is guaranteed to return true. However, if PartialEq returns true, this function may or may not return true.

Example

use rocket::http::MediaType;

let plain = MediaType::Plain;
let plain2 = MediaType::with_params("text", "plain", ("charset", "utf-8"));
let just_plain = MediaType::new("text", "plain");

// The `PartialEq` implementation doesn't consider parameters.
assert!(plain == just_plain);
assert!(just_plain == plain2);
assert!(plain == plain2);

// While `exact_eq` does.
assert!(!plain.exact_eq(&just_plain));
assert!(!plain2.exact_eq(&just_plain));
assert!(plain.exact_eq(&plain2));

pub fn params<'a>(     &'a self ) -> impl Iterator<Item = (&'a str, &'a str)> + 'a

Returns an iterator over the (key, value) pairs of the media type's parameter list. The iterator will be empty if the media type has no parameters.

Example

The MediaType::Plain type has one parameter: charset=utf-8:

use rocket::http::MediaType;

let plain = MediaType::Plain;
let plain_params: Vec<_> = plain.params().collect();
assert_eq!(plain_params, vec![("charset", "utf-8")]);

The MediaType::PNG type has no parameters:

use rocket::http::MediaType;

let png = MediaType::PNG;
assert_eq!(png.params().count(), 0);

pub const Any: MediaType

pub fn is_any(&self) -> bool

Returns true if self is the media type for any media type , without considering parameters.

pub const Binary: MediaType

pub fn is_binary(&self) -> bool

Returns true if self is the media type for binary data , without considering parameters.

pub const HTML: MediaType

pub fn is_html(&self) -> bool

Returns true if self is the media type for HTML , without considering parameters.

pub const Plain: MediaType

pub fn is_plain(&self) -> bool

Returns true if self is the media type for plain text , without considering parameters.

pub const JSON: MediaType

pub fn is_json(&self) -> bool

Returns true if self is the media type for JSON , without considering parameters.

pub const MsgPack: MediaType

pub fn is_msgpack(&self) -> bool

Returns true if self is the media type for MessagePack , without considering parameters.

pub const Form: MediaType

pub fn is_form(&self) -> bool

Returns true if self is the media type for forms , without considering parameters.

pub const JavaScript: MediaType

pub fn is_javascript(&self) -> bool

Returns true if self is the media type for JavaScript , without considering parameters.

pub const CSS: MediaType

pub fn is_css(&self) -> bool

Returns true if self is the media type for CSS , without considering parameters.

pub const FormData: MediaType

pub fn is_form_data(&self) -> bool

Returns true if self is the media type for multipart form data , without considering parameters.

pub const XML: MediaType

pub fn is_xml(&self) -> bool

Returns true if self is the media type for XML , without considering parameters.

pub const CSV: MediaType

pub fn is_csv(&self) -> bool

Returns true if self is the media type for CSV , without considering parameters.

pub const PNG: MediaType

pub fn is_png(&self) -> bool

Returns true if self is the media type for PNG , without considering parameters.

pub const GIF: MediaType

pub fn is_gif(&self) -> bool

Returns true if self is the media type for GIF , without considering parameters.

pub const BMP: MediaType

pub fn is_bmp(&self) -> bool

Returns true if self is the media type for BMP , without considering parameters.

pub const JPEG: MediaType

pub fn is_jpeg(&self) -> bool

Returns true if self is the media type for JPEG , without considering parameters.

pub const WEBP: MediaType

pub fn is_webp(&self) -> bool

Returns true if self is the media type for WEBP , without considering parameters.

pub const SVG: MediaType

pub fn is_svg(&self) -> bool

Returns true if self is the media type for SVG , without considering parameters.

pub const WEBM: MediaType

pub fn is_webm(&self) -> bool

Returns true if self is the media type for WEBM , without considering parameters.

pub const OGG: MediaType

pub fn is_ogg(&self) -> bool

Returns true if self is the media type for OGG , without considering parameters.

pub const WAV: MediaType

pub fn is_wav(&self) -> bool

Returns true if self is the media type for WAV , without considering parameters.

pub const PDF: MediaType

pub fn is_pdf(&self) -> bool

Returns true if self is the media type for PDF , without considering parameters.

pub const TTF: MediaType

pub fn is_ttf(&self) -> bool

Returns true if self is the media type for TTF , without considering parameters.

pub const OTF: MediaType

pub fn is_otf(&self) -> bool

Returns true if self is the media type for OTF , without considering parameters.

pub const WOFF: MediaType

pub fn is_woff(&self) -> bool

Returns true if self is the media type for WOFF , without considering parameters.

pub const WOFF2: MediaType

pub fn is_woff2(&self) -> bool

Returns true if self is the media type for WOFF2 , without considering parameters.

pub const WASM: MediaType

pub fn is_wasm(&self) -> bool

Returns true if self is the media type for WASM , without considering parameters.

pub const JsonApi: MediaType

pub fn is_json_api(&self) -> bool

Returns true if self is the media type for JSON API , without considering parameters.

pub fn is_known(&self) -> bool

Returns true if this MediaType is known to Rocket, that is, there is an associated constant for self.

Trait Implementations

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

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 Into<Header<'static>> for ContentType

Creates a new Header with name Content-Type and the value set to the HTTP rendering of this Content-Type.

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

Performs the conversion.

impl Default for ContentType

fn default() -> ContentType

Returns a ContentType of Any, or */*.

impl PartialEq<ContentType> for ContentType

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

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

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

This method tests for !=.

impl Clone for ContentType

fn clone(&self) -> ContentType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for ContentType

type Target = MediaType

The resulting type after dereferencing.

fn deref(&self) -> &MediaType

Dereferences the value.

impl Debug for ContentType

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

Formats the value using the given formatter.

impl Display for ContentType

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

Formats the ContentType as an HTTP Content-Type value.

Example

use rocket::http::ContentType;

let ct = format!("{}", ContentType::JSON);
assert_eq!(ct, "application/json");

impl Hash for ContentType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where     H: Hasher,

Feeds a slice of this type into the given [Hasher].

impl FromStr for ContentType

type Err = String

The associated error which can be returned from parsing.

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

Parses a ContentType from a given Content-Type header value.

Examples

Parsing an application/json:

use std::str::FromStr;
use rocket::http::ContentType;

let json = ContentType::from_str("application/json").unwrap();
assert!(json.is_known());
assert_eq!(json, ContentType::JSON);

Parsing a content type extension:

use std::str::FromStr;
use rocket::http::ContentType;

let custom = ContentType::from_str("application/x-custom").unwrap();
assert!(!custom.is_known());
assert_eq!(custom.top(), "application");
assert_eq!(custom.sub(), "x-custom");

Parsing an invalid Content-Type value:

use std::str::FromStr;
use rocket::http::ContentType;

let custom = ContentType::from_str("application//x-custom");
assert!(custom.is_err());