Struct rocket_http::QMediaType

pub struct QMediaType(pub MediaType, pub Option<f32>);

A MediaType with an associated quality value.

Tuple Fields

0: MediaType

1: Option<f32>

Implementations

impl QMediaType

pub fn weight(&self) -> Option<f32>

Retrieve the weight of the media type, if there is any.

Example

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

let q_type = QMediaType(MediaType::HTML, Some(0.3));
assert_eq!(q_type.weight(), Some(0.3));

pub fn weight_or(&self, default: f32) -> f32

Retrieve the weight of the media type or a given default value.

Example

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

let q_type = QMediaType(MediaType::HTML, Some(0.3));
assert_eq!(q_type.weight_or(0.9), 0.3);

let q_type = QMediaType(MediaType::HTML, None);
assert_eq!(q_type.weight_or(0.9), 0.9);

pub fn media_type(&self) -> &MediaType

Borrow the internal MediaType.

Example

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

let q_type = QMediaType(MediaType::HTML, Some(0.3));
assert_eq!(q_type.media_type(), &MediaType::HTML);

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 each other, including with respect to their parameters and their order.

This is different from the PartialEq implementation in that it considers parameters. In particular, Eq implies PartialEq but PartialEq does not imply Eq. That is, if PartialEq returns false, this function is guaranteed to return false. Similarly, if exact_eq returns true, PartialEq is guaranteed to return true. However, if PartialEq returns true, exact_eq function may or may not return true.

Example

use rocket::http::MediaType;

let plain = MediaType::Plain;
let plain2 = MediaType::new("text", "plain").with_params(("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(&self) -> impl Iterator<Item = (&UncasedStr, &str)> + '_

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 (key, val) = plain.params().next().unwrap();
assert_eq!(key, "charset");
assert_eq!(val, "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 param<'a>(&'a self, name: &str) -> Option<&'a str>

Returns the first parameter with name name, if there is any.

pub fn extension(&self) -> Option<&UncasedStr>

Returns the most common file extension associated with the Media-Type self if it is known. Otherwise, returns None . The currently recognized extensions are identical to those in MediaType::from_extension() with the most common extension being the first extension appearing in the list for a given Media-Type .

Example

Known extension:

use rocket::http::MediaType;

assert_eq!(MediaType::JSON.extension().unwrap(), "json");
assert_eq!(MediaType::JPEG.extension().unwrap(), "jpeg");
assert_eq!(MediaType::JPEG.extension().unwrap(), "JPEG");
assert_eq!(MediaType::PDF.extension().unwrap(), "pdf");

An unknown extension:

use rocket::http::MediaType;

let foo = MediaType::new("foo", "bar");
assert!(foo.extension().is_none());

pub const Any: MediaType = MediaType::new_known("*/*", "*", "*", &[])

pub const Binary: MediaType = MediaType::new_known("application/octet-stream", "application", "octet-stream", &[])

pub const Bytes: MediaType = MediaType::new_known("application/octet-stream", "application", "octet-stream", &[])

pub const HTML: MediaType = MediaType::new_known("text/html; charset=utf-8", "text", "html", &[("charset", "utf-8")])

pub const Plain: MediaType = MediaType::new_known("text/plain; charset=utf-8", "text", "plain", &[("charset", "utf-8")])

pub const Text: MediaType = MediaType::new_known("text/plain; charset=utf-8", "text", "plain", &[("charset", "utf-8")])

pub const JSON: MediaType = MediaType::new_known("application/json", "application", "json", &[])

pub const MsgPack: MediaType = MediaType::new_known("application/msgpack", "application", "msgpack", &[])

pub const Form: MediaType = MediaType::new_known("application/x-www-form-urlencoded", "application", "x-www-form-urlencoded", &[])

pub const JavaScript: MediaType = MediaType::new_known("application/javascript", "application", "javascript", &[])

pub const CSS: MediaType = MediaType::new_known("text/css; charset=utf-8", "text", "css", &[("charset", "utf-8")])

pub const FormData: MediaType = MediaType::new_known("multipart/form-data", "multipart", "form-data", &[])

pub const XML: MediaType = MediaType::new_known("text/xml; charset=utf-8", "text", "xml", &[("charset", "utf-8")])

pub const CSV: MediaType = MediaType::new_known("text/csv; charset=utf-8", "text", "csv", &[("charset", "utf-8")])

pub const PNG: MediaType = MediaType::new_known("image/png", "image", "png", &[])

pub const GIF: MediaType = MediaType::new_known("image/gif", "image", "gif", &[])

pub const BMP: MediaType = MediaType::new_known("image/bmp", "image", "bmp", &[])

pub const JPEG: MediaType = MediaType::new_known("image/jpeg", "image", "jpeg", &[])

pub const WEBP: MediaType = MediaType::new_known("image/webp", "image", "webp", &[])

pub const AVIF: MediaType = MediaType::new_known("image/avif", "image", "avif", &[])

pub const SVG: MediaType = MediaType::new_known("image/svg+xml", "image", "svg+xml", &[])

pub const Icon: MediaType = MediaType::new_known("image/x-icon", "image", "x-icon", &[])

pub const WEBM: MediaType = MediaType::new_known("video/webm", "video", "webm", &[])

pub const WEBA: MediaType = MediaType::new_known("audio/webm", "audio", "webm", &[])

pub const OGG: MediaType = MediaType::new_known("video/ogg", "video", "ogg", &[])

pub const FLAC: MediaType = MediaType::new_known("audio/flac", "audio", "flac", &[])

pub const WAV: MediaType = MediaType::new_known("audio/wav", "audio", "wav", &[])

pub const PDF: MediaType = MediaType::new_known("application/pdf", "application", "pdf", &[])

pub const TTF: MediaType = MediaType::new_known("application/font-sfnt", "application", "font-sfnt", &[])

pub const OTF: MediaType = MediaType::new_known("application/font-sfnt", "application", "font-sfnt", &[])

pub const WOFF: MediaType = MediaType::new_known("application/font-woff", "application", "font-woff", &[])

pub const WOFF2: MediaType = MediaType::new_known("font/woff2", "font", "woff2", &[])

pub const JsonApi: MediaType = MediaType::new_known("application/vnd.api+json", "application", "vnd.api+json", &[])

pub const WASM: MediaType = MediaType::new_known("application/wasm", "application", "wasm", &[])

pub const TIFF: MediaType = MediaType::new_known("image/tiff", "image", "tiff", &[])

pub const AAC: MediaType = MediaType::new_known("audio/aac", "audio", "aac", &[])

pub const Calendar: MediaType = MediaType::new_known("text/calendar", "text", "calendar", &[])

pub const MPEG: MediaType = MediaType::new_known("video/mpeg", "video", "mpeg", &[])

pub const TAR: MediaType = MediaType::new_known("application/x-tar", "application", "x-tar", &[])

pub const GZIP: MediaType = MediaType::new_known("application/gzip", "application", "gzip", &[])

pub const MOV: MediaType = MediaType::new_known("video/quicktime", "video", "quicktime", &[])

pub const MP4: MediaType = MediaType::new_known("video/mp4", "video", "mp4", &[])

pub const ZIP: MediaType = MediaType::new_known("application/zip", "application", "zip", &[])

pub const EventStream: MediaType = MediaType::new_known("text/event-stream", "text", "event-stream", &[])

pub const Markdown: MediaType = MediaType::new_known("text/markdown; charset=utf-8", "text", "markdown", &[("charset", "utf-8")])

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

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

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

pub fn is_bytes(&self) -> bool

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

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

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

pub fn is_text(&self) -> bool

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn is_avif(&self) -> bool

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn is_mp4(&self) -> bool

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

pub fn is_zip(&self) -> bool

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

pub fn is_event_stream(&self) -> bool

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

pub fn is_markdown(&self) -> bool

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

Trait Implementations

impl Clone for QMediaType

fn clone(&self) -> QMediaType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QMediaType

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

Formats the value using the given formatter.

impl Deref for QMediaType

type Target = MediaType

The resulting type after dereferencing.

fn deref(&self) -> &MediaType

Dereferences the value.

impl From<MediaType> for QMediaType

fn from(media_type: MediaType) -> QMediaType

Converts to this type from the input type.

impl PartialEq<QMediaType> for QMediaType

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

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

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

This method tests for !=.

impl StructuralPartialEq for QMediaType