Struct rocket::http::MediaType [−] [src]

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 new, with_params, and 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 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`
[src]

`fn new<T, S>(top: T, sub: S) -> MediaType where T: Into<Cow<'static, str>>, S: Into<Cow<'static, str>>,`
[src]

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

`fn with_params<T, S, K, V, P>(top: T, sub: S, ps: P) -> MediaType 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)>,`
[src]

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

`fn from_extension(ext: &str) -> Option<MediaType>`
[src]

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

`fn top(&self) -> &UncasedStr`
[src]

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

`fn sub(&self) -> &UncasedStr`
[src]

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

`fn specificity(&self) -> u8`
[src]

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

`fn exact_eq(&self, other: &MediaType) -> bool`
[src]

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

`fn params<'a>(&'a self) -> impl Iterator<Item = (&'a str, &'a str)> + 'a`
[src]

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