Struct rocket::http::QMediaType [−][src]
A MediaType with an associated quality value.
Methods
impl QMediaType[src]
impl QMediaTypepub fn weight(&self) -> Option<f32>[src]
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[src]
pub fn weight_or(&self, default: f32) -> f32Retrieve 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]
pub fn media_type(&self) -> &MediaTypeBorrow 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]
pub fn top(&self) -> &UncasedStrReturns 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]
pub fn sub(&self) -> &UncasedStrReturns 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]
pub fn specificity(&self) -> u8Returns 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]
pub fn exact_eq(&self, other: &MediaType) -> boolCompares 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));
pub fn params<'a>(
&'a self
) -> impl Iterator<Item = (&'a str, &'a str)> + 'a[src]
pub fn params<'a>(
&'a self
) -> impl Iterator<Item = (&'a str, &'a str)> + 'aReturns 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
pub fn is_any(&self) -> bool[src]
pub fn is_any(&self) -> boolReturns true if self is the media type for
any media type
,
without considering parameters.
pub const Binary: MediaType
pub fn is_binary(&self) -> bool[src]
pub fn is_binary(&self) -> boolReturns true if self is the media type for
binary data
,
without considering parameters.
pub const HTML: MediaType
pub fn is_html(&self) -> bool[src]
pub fn is_html(&self) -> boolReturns true if self is the media type for
HTML
,
without considering parameters.
pub const Plain: MediaType
pub fn is_plain(&self) -> bool[src]
pub fn is_plain(&self) -> boolReturns true if self is the media type for
plain text
,
without considering parameters.
pub const JSON: MediaType
pub fn is_json(&self) -> bool[src]
pub fn is_json(&self) -> boolReturns true if self is the media type for
JSON
,
without considering parameters.
pub const MsgPack: MediaType
pub fn is_msgpack(&self) -> bool[src]
pub fn is_msgpack(&self) -> boolReturns true if self is the media type for
MessagePack
,
without considering parameters.
pub const Form: MediaType
pub fn is_form(&self) -> bool[src]
pub fn is_form(&self) -> boolReturns true if self is the media type for
forms
,
without considering parameters.
pub const JavaScript: MediaType
pub fn is_javascript(&self) -> bool[src]
pub fn is_javascript(&self) -> boolReturns true if self is the media type for
JavaScript
,
without considering parameters.
pub const CSS: MediaType
pub fn is_css(&self) -> bool[src]
pub fn is_css(&self) -> boolReturns true if self is the media type for
CSS
,
without considering parameters.
pub const FormData: MediaType
pub fn is_form_data(&self) -> bool[src]
pub fn is_form_data(&self) -> boolReturns true if self is the media type for
multipart form data
,
without considering parameters.
pub const XML: MediaType
pub fn is_xml(&self) -> bool[src]
pub fn is_xml(&self) -> boolReturns true if self is the media type for
XML
,
without considering parameters.
pub const CSV: MediaType
pub fn is_csv(&self) -> bool[src]
pub fn is_csv(&self) -> boolReturns true if self is the media type for
CSV
,
without considering parameters.
pub const PNG: MediaType
pub fn is_png(&self) -> bool[src]
pub fn is_png(&self) -> boolReturns true if self is the media type for
PNG
,
without considering parameters.
pub const GIF: MediaType
pub fn is_gif(&self) -> bool[src]
pub fn is_gif(&self) -> boolReturns true if self is the media type for
GIF
,
without considering parameters.
pub const BMP: MediaType
pub fn is_bmp(&self) -> bool[src]
pub fn is_bmp(&self) -> boolReturns true if self is the media type for
BMP
,
without considering parameters.
pub const JPEG: MediaType
pub fn is_jpeg(&self) -> bool[src]
pub fn is_jpeg(&self) -> boolReturns true if self is the media type for
JPEG
,
without considering parameters.
pub const WEBP: MediaType
pub fn is_webp(&self) -> bool[src]
pub fn is_webp(&self) -> boolReturns true if self is the media type for
WEBP
,
without considering parameters.
pub const SVG: MediaType
pub fn is_svg(&self) -> bool[src]
pub fn is_svg(&self) -> boolReturns true if self is the media type for
SVG
,
without considering parameters.
pub const WEBM: MediaType
pub fn is_webm(&self) -> bool[src]
pub fn is_webm(&self) -> boolReturns true if self is the media type for
WEBM
,
without considering parameters.
pub const OGG: MediaType
pub fn is_ogg(&self) -> bool[src]
pub fn is_ogg(&self) -> boolReturns true if self is the media type for
OGG
,
without considering parameters.
pub const WAV: MediaType
pub fn is_wav(&self) -> bool[src]
pub fn is_wav(&self) -> boolReturns true if self is the media type for
WAV
,
without considering parameters.
pub const PDF: MediaType
pub fn is_pdf(&self) -> bool[src]
pub fn is_pdf(&self) -> boolReturns true if self is the media type for
PDF
,
without considering parameters.
pub const TTF: MediaType
pub fn is_ttf(&self) -> bool[src]
pub fn is_ttf(&self) -> boolReturns true if self is the media type for
TTF
,
without considering parameters.
pub const OTF: MediaType
pub fn is_otf(&self) -> bool[src]
pub fn is_otf(&self) -> boolReturns true if self is the media type for
OTF
,
without considering parameters.
pub const WOFF: MediaType
pub fn is_woff(&self) -> bool[src]
pub fn is_woff(&self) -> boolReturns true if self is the media type for
WOFF
,
without considering parameters.
pub const WOFF2: MediaType
pub fn is_woff2(&self) -> bool[src]
pub fn is_woff2(&self) -> boolReturns true if self is the media type for
WOFF2
,
without considering parameters.
pub const WASM: MediaType
pub fn is_wasm(&self) -> bool[src]
pub fn is_wasm(&self) -> boolReturns true if self is the media type for
WASM
,
without considering parameters.
pub const JsonApi: MediaType
pub fn is_json_api(&self) -> bool[src]
pub fn is_json_api(&self) -> boolReturns true if self is the media type for
JSON API
,
without considering parameters.
pub fn is_known(&self) -> bool[src]
pub fn is_known(&self) -> boolReturns true if this MediaType is known to Rocket, that is,
there is an associated constant for self.
Trait Implementations
impl Debug for QMediaType[src]
impl Debug for QMediaTypefn fmt(&self, f: &mut Formatter) -> Result[src]
fn fmt(&self, f: &mut Formatter) -> ResultFormats the value using the given formatter. Read more
impl Clone for QMediaType[src]
impl Clone for QMediaTypefn clone(&self) -> QMediaType[src]
fn clone(&self) -> QMediaTypeReturns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0[src]
fn clone_from(&mut self, source: &Self)Performs copy-assignment from source. Read more
impl PartialEq for QMediaType[src]
impl PartialEq for QMediaTypefn eq(&self, other: &QMediaType) -> bool[src]
fn eq(&self, other: &QMediaType) -> boolThis method tests for self and other values to be equal, and is used by ==. Read more
fn ne(&self, other: &QMediaType) -> bool[src]
fn ne(&self, other: &QMediaType) -> boolThis method tests for !=.
impl From<MediaType> for QMediaType[src]
impl From<MediaType> for QMediaTypefn from(media_type: MediaType) -> QMediaType[src]
fn from(media_type: MediaType) -> QMediaTypePerforms the conversion.
impl Deref for QMediaType[src]
impl Deref for QMediaTypeAuto Trait Implementations
impl Send for QMediaType
impl Send for QMediaTypeimpl Sync for QMediaType
impl Sync for QMediaType