[]Struct rocket::http::MediaType

pub struct MediaType { /* fields omitted */ }

An HTTP media type.

Usage

A MediaType should rarely be used directly. Instead, one is typically used indirectly via types like Accept and ContentType, which internally contain MediaTypes. Nonetheless, a MediaType can be created via the MediaType::new(), MediaType::with_params(), and MediaType::from_extension() methods. The preferred method, however, is to create a MediaType via an associated constant.

Example

A media type of application/json can be instantiated via the MediaType::JSON constant:

use rocket::http::MediaType;

let json = MediaType::JSON;
assert_eq!(json.top(), "application");
assert_eq!(json.sub(), "json");

let json = MediaType::new("application", "json");
assert_eq!(MediaType::JSON, json);

Comparison and Hashing

The PartialEq and Hash implementations for MediaType do not take into account parameters. This means that a media type of text/html is equal to a media type of text/html; charset=utf-8, for instance. This is typically the comparison that is desired.

If an exact comparison is desired that takes into account parameters, the exact_eq() method can be used.

Methods

impl MediaType

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

Example

Create a custom application/x-person media type:

use rocket::http::MediaType;

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

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

Example

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

use rocket::http::MediaType;

let id = MediaType::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 media type:

use rocket::http::MediaType;

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

Flexibly parses name into a MediaType . The parse is flexible because, in addition to stricly correct media types, it recognizes the following shorthands:

  • "any" - MediaType::Any
  • "binary" - MediaType::Binary
  • "html" - MediaType::HTML
  • "plain" - MediaType::Plain
  • "json" - MediaType::JSON
  • "msgpack" - MediaType::MsgPack
  • "form" - MediaType::Form
  • "js" - MediaType::JavaScript
  • "css" - MediaType::CSS
  • "multipart" - MediaType::FormData
  • "xml" - MediaType::XML

For regular parsing, use the MediaType::from_str() method.

Example

Using a shorthand:

use rocket::http::MediaType;

let html = MediaType::parse_flexible("html");
assert_eq!(html, Some(MediaType::HTML));

let json = MediaType::parse_flexible("json");
assert_eq!(json, Some(MediaType::JSON));

Using the full media type:

use rocket::http::MediaType;

let html = MediaType::parse_flexible("text/html; charset=utf-8");
assert_eq!(html, Some(MediaType::HTML));

let json = MediaType::parse_flexible("application/json");
assert_eq!(json, Some(MediaType::JSON));

let custom = MediaType::parse_flexible("application/x+custom");
assert_eq!(custom, Some(MediaType::new("application", "x+custom")));

An unrecognized media type:

use rocket::http::MediaType;

let foo = MediaType::parse_flexible("foo");
assert_eq!(foo, None);

let bar = MediaType::parse_flexible("foo/bar/baz");
assert_eq!(bar, None);

Returns the Media-Type associated with the extension ext . Not all extensions are recognized. If an extensions is not recognized, None is returned. The currently recognized extensions are:

  • txt - MediaType::Plain
  • html - MediaType::HTML
  • htm - MediaType::HTML
  • xml - MediaType::XML
  • csv - MediaType::CSV
  • js - MediaType::JavaScript
  • css - MediaType::CSS
  • json - MediaType::JSON
  • png - MediaType::PNG
  • gif - MediaType::GIF
  • bmp - MediaType::BMP
  • jpeg - MediaType::JPEG
  • jpg - MediaType::JPEG
  • webp - MediaType::WEBP
  • svg - MediaType::SVG
  • ico - MediaType::Icon
  • flac - MediaType::FLAC
  • wav - MediaType::WAV
  • webm - MediaType::WEBM
  • weba - MediaType::WEBA
  • ogg - MediaType::OGG
  • ogv - MediaType::OGG
  • pdf - MediaType::PDF
  • ttf - MediaType::TTF
  • otf - MediaType::OTF
  • woff - MediaType::WOFF
  • woff2 - MediaType::WOFF2
  • mp4 - MediaType::MP4
  • mpeg4 - MediaType::MP4
  • wasm - MediaType::WASM
  • aac - MediaType::AAC
  • ics - MediaType::Calendar
  • bin - MediaType::Binary
  • mpg - MediaType::MPEG
  • mpeg - MediaType::MPEG
  • tar - MediaType::TAR
  • gz - MediaType::GZIP
  • tif - MediaType::TIFF
  • tiff - MediaType::TIFF
  • mov - MediaType::MOV
  • zip - MediaType::ZIP

This list is likely to grow. Extensions are matched case-insensitively.

Example

Recognized media types:

use rocket::http::MediaType;

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

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

An unrecognized media type:

use rocket::http::MediaType;

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

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

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

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

Compares self with other and returns true if self and other are exactly equal to each other, 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));

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

Media Type for any media type: */*.

Media Type for binary data: application/octet-stream.

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

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

Media Type for JSON: application/json.

Media Type for MsgPack: application/msgpack.

Media Type for forms: application/x-www-form-urlencoded.

Media Type for JavaScript: application/javascript.

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

Media Type for multipart form data: multipart/form-data.

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

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

Media Type for PNG: image/png.

Media Type for GIF: image/gif.

Media Type for BMP: image/bmp.

Media Type for JPEG: image/jpeg.

Media Type for WEBP: image/webp.

Media Type for SVG: image/svg+xml.

Media Type for Icon: image/x-icon.

Media Type for WEBM: video/webm.

Media Type for WEBM Audio: audio/webm.

Media Type for OGG Video: video/ogg.

Media Type for FLAC: audio/flac.

Media Type for WAV: audio/wav.

Media Type for PDF: application/pdf.

Media Type for TTF: application/font-sfnt.

Media Type for OTF: application/font-sfnt.

Media Type for WOFF: application/font-woff.

Media Type for WOFF2: font/woff2.

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

Media Type for WASM: application/wasm.

Media Type for TIFF: image/tiff.

Media Type for AAC Audio: audio/aac.

Media Type for iCalendar: text/calendar.

Media Type for MPEG Video: video/mpeg.

Media Type for tape archive: application/x-tar.

Media Type for gzipped binary: application/gzip.

Media Type for quicktime video: video/quicktime.

Media Type for MPEG4 Video: video/mp4.

Media Type for ZIP archive: application/zip.

Returns true if this MediaType is known to Rocket. In other words, returns true if there is an associated constant for self.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::Any.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::Binary.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::HTML.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::Plain.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::JSON.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::MsgPack.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::Form.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::JavaScript.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::CSS.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::FormData.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::XML.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::CSV.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::PNG.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::GIF.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::BMP.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::JPEG.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::WEBP.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::SVG.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::Icon.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::WEBM.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::WEBA.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::OGG.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::FLAC.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::WAV.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::PDF.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::TTF.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::OTF.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::WOFF.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::WOFF2.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::JsonApi.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::WASM.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::TIFF.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::AAC.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::Calendar.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::MPEG.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::TAR.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::GZIP.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::MOV.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::MP4.

Returns true if the top-level and sublevel types of self are the same as those of MediaType::ZIP.

Trait Implementations

impl From<MediaType> for QMediaType

impl FromStr for MediaType

The associated error which can be returned from parsing.

impl PartialEq<MediaType> for MediaType

This method tests for !=.

impl Clone for MediaType

Performs copy-assignment from source. Read more

impl Display for MediaType

impl Hash for MediaType

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

impl Debug for MediaType

Auto Trait Implementations

impl Send for MediaType

impl Sync for MediaType

Blanket Implementations

impl<T> From for T
[src]

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T> Typeable for T where
    T: Any

Get the TypeId of this object.

impl<T> IntoCollection for T

impl<T, I> AsResult for T where
    I: Input,