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

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

Expand description

A MediaType with an associated quality value.

Implementations

`impl QMediaType`[src]

`pub fn weight(&self) -> Option<f32>`[src]

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`[src]

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`[src]

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

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

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

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

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

`pub const Any: MediaType`[src]

`pub const Binary: MediaType`[src]

`pub const HTML: MediaType`[src]

`pub const Plain: MediaType`[src]

`pub const JSON: MediaType`[src]

`pub const MsgPack: MediaType`[src]

`pub const Form: MediaType`[src]

`pub const JavaScript: MediaType`[src]

`pub const CSS: MediaType`[src]

`pub const FormData: MediaType`[src]

`pub const XML: MediaType`[src]

`pub const CSV: MediaType`[src]

`pub const PNG: MediaType`[src]

`pub const GIF: MediaType`[src]

`pub const BMP: MediaType`[src]

`pub const JPEG: MediaType`[src]

`pub const WEBP: MediaType`[src]

`pub const SVG: MediaType`[src]

`pub const Icon: MediaType`[src]

`pub const WEBM: MediaType`[src]

`pub const WEBA: MediaType`[src]

`pub const OGG: MediaType`[src]

`pub const FLAC: MediaType`[src]

`pub const WAV: MediaType`[src]

`pub const PDF: MediaType`[src]

`pub const TTF: MediaType`[src]

`pub const OTF: MediaType`[src]

`pub const WOFF: MediaType`[src]

`pub const WOFF2: MediaType`[src]

`pub const JsonApi: MediaType`[src]

`pub const WASM: MediaType`[src]

`pub const TIFF: MediaType`[src]

`pub const AAC: MediaType`[src]

`pub const Calendar: MediaType`[src]

`pub const MPEG: MediaType`[src]

`pub const TAR: MediaType`[src]

`pub const GZIP: MediaType`[src]

`pub const MOV: MediaType`[src]

`pub const MP4: MediaType`[src]

`pub const ZIP: MediaType`[src]

`pub fn is_known(&self) -> bool`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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

Trait Implementations

`impl Clone for QMediaType`[src]

`pub fn clone(&self) -> QMediaType`[src]

Returns a copy of the value. Read more

`fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from source. Read more

`impl Debug for QMediaType`[src]

`pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

Formats the value using the given formatter. Read more

`impl Deref for QMediaType`[src]

`type Target = MediaType`

The resulting type after dereferencing.

`pub fn deref(&self) -> &MediaType`[src]

Dereferences the value.

`impl From<MediaType> for QMediaType`[src]

`pub fn from(media_type: MediaType) -> QMediaType`[src]

Performs the conversion.

`impl PartialEq<QMediaType> for QMediaType`[src]

`pub fn eq(&self, other: &QMediaType) -> bool`[src]

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

`pub fn ne(&self, other: &QMediaType) -> bool`[src]

This method tests for !=.

`impl StructuralPartialEq for QMediaType`[src]

Auto Trait Implementations

`impl RefUnwindSafe for QMediaType`

`impl Send for QMediaType`

`impl Sync for QMediaType`

`impl Unpin for QMediaType`

`impl UnwindSafe for QMediaType`

Blanket Implementations

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

`pub fn type_id(&self) -> TypeId`[src]

Gets the TypeId of self. Read more

`impl<T, I> AsResult<T, I> for T where I: Input,` [src]

`pub fn as_result(self) -> Result<T, ParseErr>`[src]

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

`pub fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

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

`pub fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

Performs the conversion.

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

`pub fn into(self) -> U`[src]

Performs the conversion.

`impl<T> IntoCollection<T> for T`[src]

`pub fn into_collection<A>(self) -> SmallVec<A> where A: Array<Item = T>,` [src]

Converts self into a collection.

`pub fn mapped<U, F, A>(self, f: F) -> SmallVec<A> where F: FnMut(T) -> U, A: Array<Item = U>,` [src]

`impl<T> Same<T> for T`

`type Output = T`

Should always be Self

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

`type Owned = T`

The resulting type after obtaining ownership.

`pub fn to_owned(&self) -> T`[src]

Creates owned data from borrowed data, usually by cloning. Read more

`pub fn clone_into(&self, target: &mut T)`[src]

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

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

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

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

Performs the conversion.

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

`type Error = >::Error`

The type returned in the event of a conversion error.

`pub fn try_into(self) -> Result<U, >::Error>`[src]

Performs the conversion.

`impl<T> Typeable for T where T: Any,`

`fn get_type(&self) -> TypeId`

Get the TypeId of this object.

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

Implementations

impl QMediaType[src]

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

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

pub fn media_type(&self) -> &MediaType[src]

Methods from Deref<Target = MediaType>

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

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

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

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

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

pub const Any: MediaType[src]

pub const Binary: MediaType[src]

pub const HTML: MediaType[src]

pub const Plain: MediaType[src]

pub const JSON: MediaType[src]

pub const MsgPack: MediaType[src]

pub const Form: MediaType[src]

pub const JavaScript: MediaType[src]

pub const CSS: MediaType[src]

pub const FormData: MediaType[src]

pub const XML: MediaType[src]

pub const CSV: MediaType[src]

pub const PNG: MediaType[src]

pub const GIF: MediaType[src]

pub const BMP: MediaType[src]

pub const JPEG: MediaType[src]

pub const WEBP: MediaType[src]

pub const SVG: MediaType[src]

pub const Icon: MediaType[src]

pub const WEBM: MediaType[src]

pub const WEBA: MediaType[src]

pub const OGG: MediaType[src]

pub const FLAC: MediaType[src]

pub const WAV: MediaType[src]

pub const PDF: MediaType[src]

pub const TTF: MediaType[src]

pub const OTF: MediaType[src]

pub const WOFF: MediaType[src]

pub const WOFF2: MediaType[src]

pub const JsonApi: MediaType[src]

pub const WASM: MediaType[src]

pub const TIFF: MediaType[src]

pub const AAC: MediaType[src]

pub const Calendar: MediaType[src]

pub const MPEG: MediaType[src]

pub const TAR: MediaType[src]

pub const GZIP: MediaType[src]

pub const MOV: MediaType[src]

pub const MP4: MediaType[src]

pub const ZIP: MediaType[src]

pub fn is_known(&self) -> bool[src]

pub fn is_any(&self) -> bool[src]

pub fn is_binary(&self) -> bool[src]

pub fn is_html(&self) -> bool[src]

pub fn is_plain(&self) -> bool[src]

pub fn is_json(&self) -> bool[src]

pub fn is_msgpack(&self) -> bool[src]

pub fn is_form(&self) -> bool[src]

pub fn is_javascript(&self) -> bool[src]

pub fn is_css(&self) -> bool[src]

pub fn is_form_data(&self) -> bool[src]

pub fn is_xml(&self) -> bool[src]

pub fn is_csv(&self) -> bool[src]

pub fn is_png(&self) -> bool[src]

pub fn is_gif(&self) -> bool[src]

pub fn is_bmp(&self) -> bool[src]

pub fn is_jpeg(&self) -> bool[src]

pub fn is_webp(&self) -> bool[src]

pub fn is_svg(&self) -> bool[src]

pub fn is_icon(&self) -> bool[src]

pub fn is_webm(&self) -> bool[src]

pub fn is_weba(&self) -> bool[src]

pub fn is_ogg(&self) -> bool[src]

pub fn is_flac(&self) -> bool[src]

pub fn is_wav(&self) -> bool[src]

pub fn is_pdf(&self) -> bool[src]

pub fn is_ttf(&self) -> bool[src]

pub fn is_otf(&self) -> bool[src]

`impl QMediaType`[src]

`pub fn weight(&self) -> Option<f32>`[src]

`pub fn weight_or(&self, default: f32) -> f32`[src]

`pub fn media_type(&self) -> &MediaType`[src]

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

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

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

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

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

`pub const Any: MediaType`[src]

`pub const Binary: MediaType`[src]

`pub const HTML: MediaType`[src]

`pub const Plain: MediaType`[src]

`pub const JSON: MediaType`[src]

`pub const MsgPack: MediaType`[src]

`pub const Form: MediaType`[src]

`pub const JavaScript: MediaType`[src]

`pub const CSS: MediaType`[src]

`pub const FormData: MediaType`[src]

`pub const XML: MediaType`[src]

`pub const CSV: MediaType`[src]

`pub const PNG: MediaType`[src]

`pub const GIF: MediaType`[src]

`pub const BMP: MediaType`[src]

`pub const JPEG: MediaType`[src]

`pub const WEBP: MediaType`[src]

`pub const SVG: MediaType`[src]

`pub const Icon: MediaType`[src]

`pub const WEBM: MediaType`[src]

`pub const WEBA: MediaType`[src]

`pub const OGG: MediaType`[src]

`pub const FLAC: MediaType`[src]

`pub const WAV: MediaType`[src]

`pub const PDF: MediaType`[src]

`pub const TTF: MediaType`[src]

`pub const OTF: MediaType`[src]

`pub const WOFF: MediaType`[src]

`pub const WOFF2: MediaType`[src]

`pub const JsonApi: MediaType`[src]

`pub const WASM: MediaType`[src]

`pub const TIFF: MediaType`[src]

`pub const AAC: MediaType`[src]

`pub const Calendar: MediaType`[src]

`pub const MPEG: MediaType`[src]

`pub const TAR: MediaType`[src]

`pub const GZIP: MediaType`[src]

`pub const MOV: MediaType`[src]

`pub const MP4: MediaType`[src]

`pub const ZIP: MediaType`[src]

`pub fn is_known(&self) -> bool`[src]

`pub fn is_any(&self) -> bool`[src]

`pub fn is_binary(&self) -> bool`[src]

`pub fn is_html(&self) -> bool`[src]

`pub fn is_plain(&self) -> bool`[src]

`pub fn is_json(&self) -> bool`[src]

`pub fn is_msgpack(&self) -> bool`[src]

`pub fn is_form(&self) -> bool`[src]

`pub fn is_javascript(&self) -> bool`[src]

`pub fn is_css(&self) -> bool`[src]

`pub fn is_form_data(&self) -> bool`[src]

`pub fn is_xml(&self) -> bool`[src]

`pub fn is_csv(&self) -> bool`[src]

`pub fn is_png(&self) -> bool`[src]

`pub fn is_gif(&self) -> bool`[src]

`pub fn is_bmp(&self) -> bool`[src]

`pub fn is_jpeg(&self) -> bool`[src]

`pub fn is_webp(&self) -> bool`[src]

`pub fn is_svg(&self) -> bool`[src]

`pub fn is_icon(&self) -> bool`[src]

`pub fn is_webm(&self) -> bool`[src]

`pub fn is_weba(&self) -> bool`[src]

`pub fn is_ogg(&self) -> bool`[src]

`pub fn is_flac(&self) -> bool`[src]

`pub fn is_wav(&self) -> bool`[src]

`pub fn is_pdf(&self) -> bool`[src]

`pub fn is_ttf(&self) -> bool`[src]

`pub fn is_otf(&self) -> bool`[src]

`pub fn is_woff(&self) -> bool`[src]

`pub fn is_woff2(&self) -> bool`[src]

`pub fn is_json_api(&self) -> bool`[src]