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

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

A MediaType with an associated quality value.

Methods

impl QMediaType
[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));

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

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>

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

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

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

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

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

Returns true if self is the media type for any media type , without considering parameters.

Returns true if self is the media type for binary data , without considering parameters.

Returns true if self is the media type for HTML , without considering parameters.

Returns true if self is the media type for plain text , without considering parameters.

Returns true if self is the media type for JSON , without considering parameters.

Returns true if self is the media type for MessagePack , without considering parameters.

Returns true if self is the media type for forms , without considering parameters.

Returns true if self is the media type for JavaScript , without considering parameters.

Returns true if self is the media type for CSS , without considering parameters.

Returns true if self is the media type for multipart form data , without considering parameters.

Returns true if self is the media type for XML , without considering parameters.

Returns true if self is the media type for CSV , without considering parameters.

Returns true if self is the media type for PNG , without considering parameters.

Returns true if self is the media type for GIF , without considering parameters.

Returns true if self is the media type for BMP , without considering parameters.

Returns true if self is the media type for JPEG , without considering parameters.

Returns true if self is the media type for WEBP , without considering parameters.

Returns true if self is the media type for SVG , without considering parameters.

Returns true if self is the media type for WEBM , without considering parameters.

Returns true if self is the media type for OGG , without considering parameters.

Returns true if self is the media type for WAV , without considering parameters.

Returns true if self is the media type for PDF , without considering parameters.

Returns true if self is the media type for TTF , without considering parameters.

Returns true if self is the media type for OTF , without considering parameters.

Returns true if self is the media type for WOFF , without considering parameters.

Returns true if self is the media type for WOFF2 , without considering parameters.

Returns true if self is the media type for WASM , without considering parameters.

Returns true if self is the media type for JSON API , without considering parameters.

Returns true if this MediaType is known to Rocket, that is, there is an associated constant for self.

Trait Implementations

impl From<MediaType> for QMediaType
[src]

Performs the conversion.

impl Clone for QMediaType
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl PartialEq<QMediaType> for QMediaType
[src]

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

This method tests for !=.

impl Deref for QMediaType
[src]

The resulting type after dereferencing.

Dereferences the value.

impl Debug for QMediaType
[src]

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl Send for QMediaType

impl Sync for QMediaType

Blanket Implementations

impl<T> From for T
[src]

Performs the conversion.

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

Performs the conversion.

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

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

🔬 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
    T: From<U>, 
[src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

Immutably borrows from an owned value. Read more

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

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

this method will likely be replaced by an associated static

Gets the TypeId of self. Read more

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

Mutably borrows from an owned value. Read more

impl<T> Typeable for T where
    T: Any

Get the TypeId of this object.