# mime::Mime - Rust
API documentation for the Rust `Mime` struct in crate `mime`.
Keywords: rust, rustlang, rust-lang, Mime

# Struct mime::Mime [−] [src]

    pub struct Mime { /* fields omitted */ }

A parsed mime or media type.

## Implementations

### `impl Mime` [src]

#### `pub fn type_(&self) -> Name<'_>` [src]

Get the top level media type for this `Mime`.

# Example

    let mime = mime::TEXT_PLAIN;
    assert_eq!(mime.type_(), "text");
    assert_eq!(mime.type_(), mime::TEXT);

#### `pub fn subtype(&self) -> Name<'_>` [src]

Get the subtype of this `Mime`.

# Example

    let mime = mime::TEXT_PLAIN;
    assert_eq!(mime.subtype(), "plain");
    assert_eq!(mime.subtype(), mime::PLAIN);

#### `pub fn suffix(&self) -> Option<Name<'_>>` [src]

Get an optional +suffix for this `Mime`.

# Example

    let svg = "image/svg+xml".parse::<mime::Mime>().unwrap();
    assert_eq!(svg.suffix(), Some(mime::XML));
    assert_eq!(svg.suffix().unwrap(), "xml");

    assert!(mime::TEXT_PLAIN.suffix().is_none());

#### `pub fn get_param<'a, N>(&'a self, attr: N) -> Option<Name<'a>> where
N: PartialEq<Name<'a>>,` [src]

Look up a parameter by name.

# Example

    let mime = mime::TEXT_PLAIN_UTF_8;
    assert_eq!(mime.get_param(mime::CHARSET), Some(mime::UTF_8));
    assert_eq!(mime.get_param("charset").unwrap(), "utf-8");
    assert!(mime.get_param("boundary").is_none());

    let mime = "multipart/form-data; boundary=ABCDEFG".parse::<mime::Mime>().unwrap();
    assert_eq!(mime.get_param(mime::BOUNDARY).unwrap(), "ABCDEFG");

#### `pub fn params<'a>(&'a self) -> Params<'a>ⓘ

### Notable traits for Params<'a>

`impl<'a> Iterator for Params<'a> type Item = (Name<'a>, Name<'a>);`
` [src]

Returns an iterator over the parameters.

#### `pub fn essence_str(&self) -> &str` [src]

Return a `&str` of the Mime's "essence".

## Trait Implementations

### `impl AsRef<str> for Mime` [src]

#### `fn as_ref(&self) -> &str` [src]

Performs the conversion.

### `impl Clone for Mime` [src]

#### `fn clone(&self) -> Mime` [src]

Returns a copy of the value. Read more

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

Performs copy-assignment from `source`. Read more

### `impl Debug for Mime` [src]

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

Formats the value using the given formatter. Read more

### `impl Display for Mime` [src]

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

Formats the value using the given formatter. Read more

### `impl Eq for Mime` [src]

### `impl FromStr for Mime` [src]

#### `type Err = FromStrError`

The associated error which can be returned from parsing.

#### `fn from_str(s: &str) -> Result<Mime, Self::Err>` [src]

Parses a string `s` to return a value of this type. Read more

### `impl Hash for Mime` [src]

#### `fn hash<T: Hasher>(&self, hasher: &mut T)` [src]

Feeds this value into the given `Hasher`. Read more

#### `pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,` 1.3.0 [src]

Feeds a slice of this type into the given `Hasher`. Read more

### `impl Ord for Mime` [src]

#### `fn cmp(&self, other: &Mime) -> Ordering` [src]

This method returns an `Ordering` between `self` and `other`. Read more

#### `#[must_use]pub fn max(self, other: Self) -> Self` 1.21.0 [src]

Compares and returns the maximum of two values. Read more

#### `#[must_use]pub fn min(self, other: Self) -> Self` 1.21.0 [src]

Compares and returns the minimum of two values. Read more

#### `#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self` 1.50.0 [src]

Restrict a value to a certain interval. Read more

### `impl<'a> PartialEq<&'a str> for Mime` [src]

#### `fn eq(&self, s: &&'a str) -> bool` [src]

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

#### `#[must_use]pub fn ne(&self, other: &Rhs) -> bool` 1.0.0 [src]

This method tests for `!=`.

### `impl PartialEq<Mime> for Mime` [src]

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

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

#### `#[must_use]pub fn ne(&self, other: &Rhs) -> bool` 1.0.0 [src]

This method tests for `!=`.

### `impl PartialOrd<Mime> for Mime` [src]

#### `fn partial_cmp(&self, other: &Mime) -> Option<Ordering>` [src]

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

#### `#[must_use]pub fn lt(&self, other: &Rhs) -> bool` 1.0.0 [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

#### `#[must_use]pub fn le(&self, other: &Rhs) -> bool` 1.0.0 [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

#### `#[must_use]pub fn gt(&self, other: &Rhs) -> bool` 1.0.0 [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

#### `#[must_use]pub fn ge(&self, other: &Rhs) -> bool` 1.0.0 [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

## Auto Trait Implementations

### `impl RefUnwindSafe for Mime` [src]

### `impl Send for Mime` [src]

### `impl Sync for Mime` [src]

### `impl Unpin for Mime` [src]

### `impl UnwindSafe for Mime` [src]

## 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> 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<U> for T where
U: From<T>,` [src]

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

Performs the conversion.

### `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> ToString for T where
T: Display + ?Sized,` [src]

#### `pub default fn to_string(&self) -> String` [src]

Converts the given value to a `String`. Read more

### `impl<T, U> TryFrom<U> 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<U>>::Error>` [src]

Performs the conversion.

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

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

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

Performs the conversion.