Struct MediaType 

pub struct MediaType { /* private fields */ }

A parsed media type (formerly known as a MIME type).

The type and subtype (including any +suffix) are compared case-insensitively, as are the parameter names and the value of the charset parameter. Other parameter values are compared case-sensitively.

Values of this type are always stored in their canonical form: the type, subtype and parameter names are lowercase, the parameters are separated by ; , and parameter values are unquoted.

Examples

use media_type::MediaType;

let media_type: MediaType = "IMAGE/SVG+XML; Charset=UTF-8".parse().unwrap();
assert_eq!(media_type.type_(), "image");
assert_eq!(media_type.subtype(), "svg");
assert_eq!(media_type.suffix(), Some("xml"));
assert_eq!(media_type.essence(), "image/svg+xml");
assert_eq!(media_type.to_string(), "image/svg+xml; charset=utf-8");

Implementations

impl MediaType

pub const fn from_static(source: &'static str) -> MediaType

Creates a media type from a 'static string without validating it.

The string must be a valid media type in canonical lowercase form, otherwise the accessors may return unexpected results. Prefer MediaType::from_str for untrusted input.

This is mostly useful to define your own constants:

use media_type::MediaType;

const TEXT_X_LOG: MediaType = MediaType::from_static("text/x-log");
assert_eq!(TEXT_X_LOG.subtype(), "x-log");

pub fn type_(&self) -> &str

Get the top-level media type for this MediaType.

Examples

assert_eq!(media_type::TEXT_PLAIN.type_(), "text");
assert_eq!(media_type::TEXT_PLAIN.type_(), media_type::TEXT);

pub fn subtype(&self) -> &str

Get the subtype of this MediaType, without its +suffix.

Examples

use media_type::MediaType;

assert_eq!(media_type::TEXT_PLAIN.subtype(), "plain");
let svg: MediaType = "image/svg+xml".parse().unwrap();
assert_eq!(svg.subtype(), "svg");

pub fn suffix(&self) -> Option<&str>

Get the optional +suffix of this MediaType.

Examples

use media_type::MediaType;

assert_eq!(media_type::TEXT_PLAIN.suffix(), None);
let svg: MediaType = "image/svg+xml".parse().unwrap();
assert_eq!(svg.suffix(), Some("xml"));

pub fn essence(&self) -> &str

Get the “essence” of this MediaType, that is the type and subtype without any parameter.

See the WHATWG definition.

Examples

assert_eq!(media_type::TEXT_PLAIN_UTF_8.essence(), "text/plain");

pub fn parameters(&self) -> Parameters<'_>

Return an iterator over the parameters of this MediaType.

Examples

use media_type::MediaType;

let media_type: MediaType = "text/plain; charset=utf-8; foo=bar".parse().unwrap();
let params: Vec<_> = media_type.parameters().collect();
assert_eq!(params, [("charset", "utf-8"), ("foo", "bar")]);

pub fn get_parameter<'a>(&'a self, name: &str) -> Option<&'a str>

Look up a parameter by name.

The name is matched case-insensitively. Parameter values are returned verbatim, except for the charset parameter whose value is lowercased.

Examples

assert_eq!(media_type::TEXT_PLAIN_UTF_8.get_parameter("charset"), Some("utf-8"));
assert_eq!(media_type::TEXT_PLAIN_UTF_8.get_parameter("boundary"), None);

Trait Implementations

impl AsRef<str> for MediaType

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for MediaType

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MediaType

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

Formats the value using the given formatter.

impl Display for MediaType

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

Formats the value using the given formatter.

impl Eq for MediaType

impl FromStr for MediaType

Available on crate feature alloc only.

type Err = FromStrError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<MediaType, Self::Err>

Parses a string s to return a value of this type.

impl Hash for MediaType

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MediaType

fn cmp(&self, other: &MediaType) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for MediaType

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for MediaType

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<MediaType> for &str

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for MediaType

fn partial_cmp(&self, other: &MediaType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.