Struct rocket_http::QMediaType
source · [−]Expand description
A MediaType
with an associated quality value.
Tuple Fields
0: MediaType
1: Option<f32>
Implementations
sourceimpl QMediaType
impl QMediaType
sourcepub fn weight(&self) -> Option<f32>
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));
sourcepub fn weight_or(&self, default: f32) -> f32
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);
sourcepub fn media_type(&self) -> &MediaType
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>
sourcepub 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");
sourcepub 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");
sourcepub 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);
sourcepub 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));
sourcepub 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 const Any: MediaType = MediaType{source: Source::Known("*/*"), top: Indexed::Concrete(Cow::Borrowed("*")), sub: Indexed::Concrete(Cow::Borrowed("*")), params: MediaParams::Static(&[]),}
pub const Binary: MediaType = MediaType{source: Source::Known("application/octet-stream"), top: Indexed::Concrete(Cow::Borrowed("application")), sub: Indexed::Concrete(Cow::Borrowed("octet-stream")), params: MediaParams::Static(&[]),}
pub const HTML: MediaType = MediaType{source: Source::Known("text/html; charset=utf-8"), top: Indexed::Concrete(Cow::Borrowed("text")), sub: Indexed::Concrete(Cow::Borrowed("html")), params: MediaParams::Static(&[(Indexed::Concrete(Cow::Borrowed("charset")), Indexed::Concrete(Cow::Borrowed("utf-8")))]),}
pub const Plain: MediaType = MediaType{source: Source::Known("text/plain; charset=utf-8"), top: Indexed::Concrete(Cow::Borrowed("text")), sub: Indexed::Concrete(Cow::Borrowed("plain")), params: MediaParams::Static(&[(Indexed::Concrete(Cow::Borrowed("charset")), Indexed::Concrete(Cow::Borrowed("utf-8")))]),}
pub const JSON: MediaType = MediaType{source: Source::Known("application/json"), top: Indexed::Concrete(Cow::Borrowed("application")), sub: Indexed::Concrete(Cow::Borrowed("json")), params: MediaParams::Static(&[]),}
pub const MsgPack: MediaType = MediaType{source: Source::Known("application/msgpack"), top: Indexed::Concrete(Cow::Borrowed("application")), sub: Indexed::Concrete(Cow::Borrowed("msgpack")), params: MediaParams::Static(&[]),}
pub const Form: MediaType = MediaType{source: Source::Known("application/x-www-form-urlencoded"), top: Indexed::Concrete(Cow::Borrowed("application")), sub: Indexed::Concrete(Cow::Borrowed("x-www-form-urlencoded")), params: MediaParams::Static(&[]),}
pub const JavaScript: MediaType = MediaType{source: Source::Known("application/javascript"), top: Indexed::Concrete(Cow::Borrowed("application")), sub: Indexed::Concrete(Cow::Borrowed("javascript")), params: MediaParams::Static(&[]),}
pub const CSS: MediaType = MediaType{source: Source::Known("text/css; charset=utf-8"), top: Indexed::Concrete(Cow::Borrowed("text")), sub: Indexed::Concrete(Cow::Borrowed("css")), params: MediaParams::Static(&[(Indexed::Concrete(Cow::Borrowed("charset")), Indexed::Concrete(Cow::Borrowed("utf-8")))]),}
pub const FormData: MediaType = MediaType{source: Source::Known("multipart/form-data"), top: Indexed::Concrete(Cow::Borrowed("multipart")), sub: Indexed::Concrete(Cow::Borrowed("form-data")), params: MediaParams::Static(&[]),}
pub const XML: MediaType = MediaType{source: Source::Known("text/xml; charset=utf-8"), top: Indexed::Concrete(Cow::Borrowed("text")), sub: Indexed::Concrete(Cow::Borrowed("xml")), params: MediaParams::Static(&[(Indexed::Concrete(Cow::Borrowed("charset")), Indexed::Concrete(Cow::Borrowed("utf-8")))]),}
pub const CSV: MediaType = MediaType{source: Source::Known("text/csv; charset=utf-8"), top: Indexed::Concrete(Cow::Borrowed("text")), sub: Indexed::Concrete(Cow::Borrowed("csv")), params: MediaParams::Static(&[(Indexed::Concrete(Cow::Borrowed("charset")), Indexed::Concrete(Cow::Borrowed("utf-8")))]),}
pub const PNG: MediaType = MediaType{source: Source::Known("image/png"), top: Indexed::Concrete(Cow::Borrowed("image")), sub: Indexed::Concrete(Cow::Borrowed("png")), params: MediaParams::Static(&[]),}
pub const GIF: MediaType = MediaType{source: Source::Known("image/gif"), top: Indexed::Concrete(Cow::Borrowed("image")), sub: Indexed::Concrete(Cow::Borrowed("gif")), params: MediaParams::Static(&[]),}
pub const BMP: MediaType = MediaType{source: Source::Known("image/bmp"), top: Indexed::Concrete(Cow::Borrowed("image")), sub: Indexed::Concrete(Cow::Borrowed("bmp")), params: MediaParams::Static(&[]),}
pub const JPEG: MediaType = MediaType{source: Source::Known("image/jpeg"), top: Indexed::Concrete(Cow::Borrowed("image")), sub: Indexed::Concrete(Cow::Borrowed("jpeg")), params: MediaParams::Static(&[]),}
pub const WEBP: MediaType = MediaType{source: Source::Known("image/webp"), top: Indexed::Concrete(Cow::Borrowed("image")), sub: Indexed::Concrete(Cow::Borrowed("webp")), params: MediaParams::Static(&[]),}
pub const SVG: MediaType = MediaType{source: Source::Known("image/svg+xml"), top: Indexed::Concrete(Cow::Borrowed("image")), sub: Indexed::Concrete(Cow::Borrowed("svg+xml")), params: MediaParams::Static(&[]),}
pub const Icon: MediaType = MediaType{source: Source::Known("image/x-icon"), top: Indexed::Concrete(Cow::Borrowed("image")), sub: Indexed::Concrete(Cow::Borrowed("x-icon")), params: MediaParams::Static(&[]),}
pub const WEBM: MediaType = MediaType{source: Source::Known("video/webm"), top: Indexed::Concrete(Cow::Borrowed("video")), sub: Indexed::Concrete(Cow::Borrowed("webm")), params: MediaParams::Static(&[]),}
pub const WEBA: MediaType = MediaType{source: Source::Known("audio/webm"), top: Indexed::Concrete(Cow::Borrowed("audio")), sub: Indexed::Concrete(Cow::Borrowed("webm")), params: MediaParams::Static(&[]),}
pub const OGG: MediaType = MediaType{source: Source::Known("video/ogg"), top: Indexed::Concrete(Cow::Borrowed("video")), sub: Indexed::Concrete(Cow::Borrowed("ogg")), params: MediaParams::Static(&[]),}
pub const FLAC: MediaType = MediaType{source: Source::Known("audio/flac"), top: Indexed::Concrete(Cow::Borrowed("audio")), sub: Indexed::Concrete(Cow::Borrowed("flac")), params: MediaParams::Static(&[]),}
pub const WAV: MediaType = MediaType{source: Source::Known("audio/wav"), top: Indexed::Concrete(Cow::Borrowed("audio")), sub: Indexed::Concrete(Cow::Borrowed("wav")), params: MediaParams::Static(&[]),}
pub const PDF: MediaType = MediaType{source: Source::Known("application/pdf"), top: Indexed::Concrete(Cow::Borrowed("application")), sub: Indexed::Concrete(Cow::Borrowed("pdf")), params: MediaParams::Static(&[]),}
pub const TTF: MediaType = MediaType{source: Source::Known("application/font-sfnt"), top: Indexed::Concrete(Cow::Borrowed("application")), sub: Indexed::Concrete(Cow::Borrowed("font-sfnt")), params: MediaParams::Static(&[]),}
pub const OTF: MediaType = MediaType{source: Source::Known("application/font-sfnt"), top: Indexed::Concrete(Cow::Borrowed("application")), sub: Indexed::Concrete(Cow::Borrowed("font-sfnt")), params: MediaParams::Static(&[]),}
pub const WOFF: MediaType = MediaType{source: Source::Known("application/font-woff"), top: Indexed::Concrete(Cow::Borrowed("application")), sub: Indexed::Concrete(Cow::Borrowed("font-woff")), params: MediaParams::Static(&[]),}
pub const WOFF2: MediaType = MediaType{source: Source::Known("font/woff2"), top: Indexed::Concrete(Cow::Borrowed("font")), sub: Indexed::Concrete(Cow::Borrowed("woff2")), params: MediaParams::Static(&[]),}
pub const JsonApi: MediaType = MediaType{source: Source::Known("application/vnd.api+json"), top: Indexed::Concrete(Cow::Borrowed("application")), sub: Indexed::Concrete(Cow::Borrowed("vnd.api+json")), params: MediaParams::Static(&[]),}
pub const WASM: MediaType = MediaType{source: Source::Known("application/wasm"), top: Indexed::Concrete(Cow::Borrowed("application")), sub: Indexed::Concrete(Cow::Borrowed("wasm")), params: MediaParams::Static(&[]),}
pub const TIFF: MediaType = MediaType{source: Source::Known("image/tiff"), top: Indexed::Concrete(Cow::Borrowed("image")), sub: Indexed::Concrete(Cow::Borrowed("tiff")), params: MediaParams::Static(&[]),}
pub const AAC: MediaType = MediaType{source: Source::Known("audio/aac"), top: Indexed::Concrete(Cow::Borrowed("audio")), sub: Indexed::Concrete(Cow::Borrowed("aac")), params: MediaParams::Static(&[]),}
pub const Calendar: MediaType = MediaType{source: Source::Known("text/calendar"), top: Indexed::Concrete(Cow::Borrowed("text")), sub: Indexed::Concrete(Cow::Borrowed("calendar")), params: MediaParams::Static(&[]),}
pub const MPEG: MediaType = MediaType{source: Source::Known("video/mpeg"), top: Indexed::Concrete(Cow::Borrowed("video")), sub: Indexed::Concrete(Cow::Borrowed("mpeg")), params: MediaParams::Static(&[]),}
pub const TAR: MediaType = MediaType{source: Source::Known("application/x-tar"), top: Indexed::Concrete(Cow::Borrowed("application")), sub: Indexed::Concrete(Cow::Borrowed("x-tar")), params: MediaParams::Static(&[]),}
pub const GZIP: MediaType = MediaType{source: Source::Known("application/gzip"), top: Indexed::Concrete(Cow::Borrowed("application")), sub: Indexed::Concrete(Cow::Borrowed("gzip")), params: MediaParams::Static(&[]),}
pub const MOV: MediaType = MediaType{source: Source::Known("video/quicktime"), top: Indexed::Concrete(Cow::Borrowed("video")), sub: Indexed::Concrete(Cow::Borrowed("quicktime")), params: MediaParams::Static(&[]),}
pub const MP4: MediaType = MediaType{source: Source::Known("video/mp4"), top: Indexed::Concrete(Cow::Borrowed("video")), sub: Indexed::Concrete(Cow::Borrowed("mp4")), params: MediaParams::Static(&[]),}
pub const ZIP: MediaType = MediaType{source: Source::Known("application/zip"), top: Indexed::Concrete(Cow::Borrowed("application")), sub: Indexed::Concrete(Cow::Borrowed("zip")), params: MediaParams::Static(&[]),}
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
sourcepub 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
.
Trait Implementations
sourceimpl Clone for QMediaType
impl Clone for QMediaType
sourcefn clone(&self) -> QMediaType
fn clone(&self) -> QMediaType
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for QMediaType
impl Debug for QMediaType
sourceimpl Deref for QMediaType
impl Deref for QMediaType
sourceimpl From<MediaType> for QMediaType
impl From<MediaType> for QMediaType
sourcefn from(media_type: MediaType) -> QMediaType
fn from(media_type: MediaType) -> QMediaType
Converts to this type from the input type.
sourceimpl PartialEq<QMediaType> for QMediaType
impl PartialEq<QMediaType> for QMediaType
sourcefn eq(&self, other: &QMediaType) -> bool
fn eq(&self, other: &QMediaType) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &QMediaType) -> bool
fn ne(&self, other: &QMediaType) -> bool
This method tests for !=
.
impl StructuralPartialEq for QMediaType
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more