Struct MediaType
pub struct MediaType { /* private fields */ }Expand description
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.
Implementations§
§impl MediaType
impl MediaType
pub const JavaScript: MediaType = _
pub const JavaScript: MediaType = _
Media Type for JavaScript: application/javascript.
pub fn new<T, S>(top: T, sub: S) -> MediaType
pub fn new<T, S>(top: T, sub: S) -> 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");pub fn with_params<T, S, K, V, P>(top: T, sub: S, ps: P) -> MediaType
pub fn with_params<T, S, K, V, P>(top: T, sub: S, ps: P) -> MediaType
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());pub fn parse_flexible(name: &str) -> Option<MediaType>
pub fn parse_flexible(name: &str) -> Option<MediaType>
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);pub fn from_extension(ext: &str) -> Option<MediaType>
pub fn from_extension(ext: &str) -> Option<MediaType>
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());pub fn top(&self) -> &UncasedStr
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
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
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
pub fn exact_eq(&self, other: &MediaType) -> bool
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));pub fn params<'a>(&'a self) -> impl Iterator<Item = (&'a str, &'a str)> + 'a
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 fn is_known(&self) -> bool
pub fn is_known(&self) -> bool
Returns true if this MediaType is known to Rocket. In other words,
returns true if there is an associated constant for self.
pub fn is_any(&self) -> bool
pub fn is_any(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::Any .
pub fn is_binary(&self) -> bool
pub fn is_binary(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::Binary .
pub fn is_html(&self) -> bool
pub fn is_html(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::HTML .
pub fn is_plain(&self) -> bool
pub fn is_plain(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::Plain .
pub fn is_json(&self) -> bool
pub fn is_json(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::JSON .
pub fn is_msgpack(&self) -> bool
pub fn is_msgpack(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::MsgPack .
pub fn is_form(&self) -> bool
pub fn is_form(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::Form .
pub fn is_javascript(&self) -> bool
pub fn is_javascript(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::JavaScript .
pub fn is_css(&self) -> bool
pub fn is_css(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::CSS .
pub fn is_form_data(&self) -> bool
pub fn is_form_data(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::FormData .
pub fn is_xml(&self) -> bool
pub fn is_xml(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::XML .
pub fn is_csv(&self) -> bool
pub fn is_csv(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::CSV .
pub fn is_png(&self) -> bool
pub fn is_png(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::PNG .
pub fn is_gif(&self) -> bool
pub fn is_gif(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::GIF .
pub fn is_bmp(&self) -> bool
pub fn is_bmp(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::BMP .
pub fn is_jpeg(&self) -> bool
pub fn is_jpeg(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::JPEG .
pub fn is_webp(&self) -> bool
pub fn is_webp(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::WEBP .
pub fn is_svg(&self) -> bool
pub fn is_svg(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::SVG .
pub fn is_icon(&self) -> bool
pub fn is_icon(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::Icon .
pub fn is_webm(&self) -> bool
pub fn is_webm(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::WEBM .
pub fn is_weba(&self) -> bool
pub fn is_weba(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::WEBA .
pub fn is_ogg(&self) -> bool
pub fn is_ogg(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::OGG .
pub fn is_flac(&self) -> bool
pub fn is_flac(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::FLAC .
pub fn is_wav(&self) -> bool
pub fn is_wav(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::WAV .
pub fn is_pdf(&self) -> bool
pub fn is_pdf(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::PDF .
pub fn is_ttf(&self) -> bool
pub fn is_ttf(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::TTF .
pub fn is_otf(&self) -> bool
pub fn is_otf(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::OTF .
pub fn is_woff(&self) -> bool
pub fn is_woff(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::WOFF .
pub fn is_woff2(&self) -> bool
pub fn is_woff2(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::WOFF2 .
pub fn is_json_api(&self) -> bool
pub fn is_json_api(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::JsonApi .
pub fn is_wasm(&self) -> bool
pub fn is_wasm(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::WASM .
pub fn is_tiff(&self) -> bool
pub fn is_tiff(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::TIFF .
pub fn is_aac(&self) -> bool
pub fn is_aac(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::AAC .
pub fn is_ical(&self) -> bool
pub fn is_ical(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::Calendar .
pub fn is_mpeg(&self) -> bool
pub fn is_mpeg(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::MPEG .
pub fn is_tar(&self) -> bool
pub fn is_tar(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::TAR .
pub fn is_gzip(&self) -> bool
pub fn is_gzip(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::GZIP .
pub fn is_mov(&self) -> bool
pub fn is_mov(&self) -> bool
Returns true if the top-level and sublevel types of self are the same as those of MediaType::MOV .