Struct rocket::http::MediaType

source ·
pub struct MediaType { /* private fields */ }
Expand description

An HTTP media type.

Usage

A MediaType should rarely be used directly. Instead, one is typically used indirectly via types like Accept and ContentType, which internally contain MediaTypes. Nonetheless, a MediaType can be created via the MediaType::new(), MediaType::with_params(), and MediaType::from_extension() methods. The preferred method, however, is to create a MediaType via an associated constant.

Example

A media type of application/json can be instantiated via the MediaType::JSON constant:

use rocket::http::MediaType;

let json = MediaType::JSON;
assert_eq!(json.top(), "application");
assert_eq!(json.sub(), "json");

let json = MediaType::new("application", "json");
assert_eq!(MediaType::JSON, json);

Comparison and Hashing

The PartialEq and Hash implementations for MediaType do not take into account parameters. This means that a media type of text/html is equal to a media type of text/html; charset=utf-8, for instance. This is typically the comparison that is desired.

If an exact comparison is desired that takes into account parameters, the exact_eq() method can be used.

Implementations§

source§

impl MediaType

source

pub fn new<T, S>(top: T, sub: S) -> MediaTypewhere T: Into<Cow<'static, str>>, S: Into<Cow<'static, str>>,

Creates a new MediaType with top-level type top and subtype sub. This should only be used to construct uncommon or custom media types. Use an associated constant for everything else.

Example

Create a custom application/x-person media type:

use rocket::http::MediaType;

let custom = MediaType::new("application", "x-person");
assert_eq!(custom.top(), "application");
assert_eq!(custom.sub(), "x-person");
source

pub fn with_params<K, V, P>(self, ps: P) -> MediaTypewhere K: Into<Cow<'static, str>>, V: Into<Cow<'static, str>>, P: IntoCollection<(K, V)>,

Sets the parameters parameters on self.

Example

Create a custom application/x-id; id=1 media type:

use rocket::http::MediaType;

let id = MediaType::new("application", "x-id").with_params(("id", "1"));
assert_eq!(id.to_string(), "application/x-id; id=1".to_string());

Create a custom text/person; name=bob; weight=175 media type:

use rocket::http::MediaType;

let mt = MediaType::new("text", "person")
    .with_params([("name", "bob"), ("ref", "2382")]);

assert_eq!(mt.to_string(), "text/person; name=bob; ref=2382".to_string());
source

pub const fn const_new( top: &'static str, sub: &'static str, params: &'static [(&'static str, &'static str)] ) -> MediaType

A const variant of MediaType::with_params(). Creates a new MediaType with top-level type top, subtype sub, and parameters params, which may be empty.

Example

Create a custom application/x-person media type:

use rocket::http::MediaType;

let custom = MediaType::const_new("application", "x-person", &[]);
assert_eq!(custom.top(), "application");
assert_eq!(custom.sub(), "x-person");
source

pub fn parse_flexible(name: &str) -> Option<MediaType>

Flexibly parses name into a MediaType . The parse is flexible because, in addition to strictly correct media types, it recognizes the following shorthands:

  • “any” - MediaType::Any
  • “binary” - MediaType::Binary
  • “bytes” - MediaType::Bytes
  • “html” - MediaType::HTML
  • “plain” - MediaType::Plain
  • “text” - MediaType::Text
  • “json” - MediaType::JSON
  • “msgpack” - MediaType::MsgPack
  • “form” - MediaType::Form
  • “js” - MediaType::JavaScript
  • “css” - MediaType::CSS
  • “multipart” - MediaType::FormData
  • “xml” - MediaType::XML
  • “pdf” - MediaType::PDF
  • “markdown” - MediaType::Markdown
  • “md” - MediaType::Markdown

For regular parsing, use the MediaType::from_str() method.

Example

Using a shorthand:

use rocket::http::MediaType;

let html = MediaType::parse_flexible("html");
assert_eq!(html, Some(MediaType::HTML));

let json = MediaType::parse_flexible("json");
assert_eq!(json, Some(MediaType::JSON));

Using the full media type:

use rocket::http::MediaType;

let html = MediaType::parse_flexible("text/html; charset=utf-8");
assert_eq!(html, Some(MediaType::HTML));

let json = MediaType::parse_flexible("application/json");
assert_eq!(json, Some(MediaType::JSON));

let custom = MediaType::parse_flexible("application/x+custom");
assert_eq!(custom, Some(MediaType::new("application", "x+custom")));

An unrecognized media type:

use rocket::http::MediaType;

let foo = MediaType::parse_flexible("foo");
assert_eq!(foo, None);

let bar = MediaType::parse_flexible("foo/bar/baz");
assert_eq!(bar, None);
source

pub fn from_extension(ext: &str) -> Option<MediaType>

Returns the Media-Type associated with the extension ext . Not all extensions are recognized. If an extensions is not recognized, None is returned. The currently recognized extensions are:

  • txt - MediaType::Plain
  • html - MediaType::HTML
  • htm - MediaType::HTML
  • xml - MediaType::XML
  • opf - MediaType::OPF
  • xhtml - MediaType::XHTML
  • csv - MediaType::CSV
  • js - MediaType::JavaScript
  • mjs - MediaType::JavaScript
  • css - MediaType::CSS
  • json - MediaType::JSON
  • png - MediaType::PNG
  • gif - MediaType::GIF
  • bmp - MediaType::BMP
  • jpeg - MediaType::JPEG
  • jpg - MediaType::JPEG
  • webp - MediaType::WEBP
  • avif - MediaType::AVIF
  • svg - MediaType::SVG
  • ico - MediaType::Icon
  • flac - MediaType::FLAC
  • wav - MediaType::WAV
  • webm - MediaType::WEBM
  • weba - MediaType::WEBA
  • ogg - MediaType::OGG
  • ogv - MediaType::OGG
  • pdf - MediaType::PDF
  • ttf - MediaType::TTF
  • otf - MediaType::OTF
  • woff - MediaType::WOFF
  • woff2 - MediaType::WOFF2
  • mp3 - MediaType::MP3
  • mp4 - MediaType::MP4
  • mpeg4 - MediaType::MP4
  • wasm - MediaType::WASM
  • aac - MediaType::AAC
  • ics - MediaType::Calendar
  • bin - MediaType::Binary
  • iso - MediaType::Binary
  • dmg - MediaType::Binary
  • mpg - MediaType::MPEG
  • mpeg - MediaType::MPEG
  • tar - MediaType::TAR
  • gz - MediaType::GZIP
  • tif - MediaType::TIFF
  • tiff - MediaType::TIFF
  • mov - MediaType::MOV
  • zip - MediaType::ZIP
  • cbz - MediaType::CBZ
  • cbr - MediaType::CBR
  • rar - MediaType::RAR
  • epub - MediaType::EPUB
  • md - MediaType::Markdown
  • markdown - MediaType::Markdown
  • exe - MediaType::EXE

This list is likely to grow. Extensions are matched case-insensitively.

Example

Recognized media types:

use rocket::http::MediaType;

let xml = MediaType::from_extension("xml");
assert_eq!(xml, Some(MediaType::XML));

let xml = MediaType::from_extension("XML");
assert_eq!(xml, Some(MediaType::XML));

An unrecognized media type:

use rocket::http::MediaType;

let foo = MediaType::from_extension("foo");
assert!(foo.is_none());
source

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

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

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

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 and their order.

This is different from the PartialEq implementation in that it considers parameters. In particular, Eq implies PartialEq but PartialEq does not imply Eq. That is, if PartialEq returns false, this function is guaranteed to return false. Similarly, if exact_eq returns true, PartialEq is guaranteed to return true. However, if PartialEq returns true, exact_eq function may or may not return true.

Example
use rocket::http::MediaType;

let plain = MediaType::Plain;
let plain2 = MediaType::new("text", "plain").with_params(("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));
source

pub fn params(&self) -> impl Iterator<Item = (&UncasedStr, &str)>

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 (key, val) = plain.params().next().unwrap();
assert_eq!(key, "charset");
assert_eq!(val, "utf-8");

The MediaType::PNG type has no parameters:

use rocket::http::MediaType;

let png = MediaType::PNG;
assert_eq!(png.params().count(), 0);
source

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

Returns the first parameter with name name, if there is any.

source

pub fn extension(&self) -> Option<&UncasedStr>

Returns the most common file extension associated with the Media-Type self if it is known. Otherwise, returns None . The currently recognized extensions are identical to those in MediaType::from_extension() with the most common extension being the first extension appearing in the list for a given Media-Type .

Example

Known extension:

use rocket::http::MediaType;

assert_eq!(MediaType::JSON.extension().unwrap(), "json");
assert_eq!(MediaType::JPEG.extension().unwrap(), "jpeg");
assert_eq!(MediaType::JPEG.extension().unwrap(), "JPEG");
assert_eq!(MediaType::PDF.extension().unwrap(), "pdf");

An unknown extension:

use rocket::http::MediaType;

let foo = MediaType::new("foo", "bar");
assert!(foo.extension().is_none());
source

pub const Any: MediaType = _

Media Type for any media type: */*.

source

pub const Binary: MediaType = _

Media Type for binary data: application/octet-stream.

source

pub const Bytes: MediaType = _

Media Type for binary data: application/octet-stream.

source

pub const HTML: MediaType = _

Media Type for HTML: text/html; charset=utf-8.

source

pub const Plain: MediaType = _

Media Type for plain text: text/plain; charset=utf-8.

source

pub const Text: MediaType = _

Media Type for plain text: text/plain; charset=utf-8.

source

pub const JSON: MediaType = _

Media Type for JSON: application/json.

source

pub const MsgPack: MediaType = _

Media Type for MsgPack: application/msgpack.

source

pub const Form: MediaType = _

Media Type for forms: application/x-www-form-urlencoded.

source

pub const JavaScript: MediaType = _

Media Type for JavaScript: text/javascript.

source

pub const CSS: MediaType = _

Media Type for CSS: text/css; charset=utf-8.

source

pub const FormData: MediaType = _

Media Type for multipart form data: multipart/form-data.

source

pub const XML: MediaType = _

Media Type for XML: text/xml; charset=utf-8.

source

pub const OPF: MediaType = _

Media Type for OPF: application/oebps-package+xml.

source

pub const XHTML: MediaType = _

Media Type for XHTML: application/xhtml+xml.

source

pub const CSV: MediaType = _

Media Type for CSV: text/csv; charset=utf-8.

source

pub const PNG: MediaType = _

Media Type for PNG: image/png.

source

pub const GIF: MediaType = _

Media Type for GIF: image/gif.

source

pub const BMP: MediaType = _

Media Type for BMP: image/bmp.

source

pub const JPEG: MediaType = _

Media Type for JPEG: image/jpeg.

source

pub const WEBP: MediaType = _

Media Type for WEBP: image/webp.

source

pub const AVIF: MediaType = _

Media Type for AVIF: image/avif.

source

pub const SVG: MediaType = _

Media Type for SVG: image/svg+xml.

source

pub const Icon: MediaType = _

Media Type for Icon: image/x-icon.

source

pub const WEBM: MediaType = _

Media Type for WEBM: video/webm.

source

pub const WEBA: MediaType = _

Media Type for WEBM Audio: audio/webm.

source

pub const OGG: MediaType = _

Media Type for OGG Video: video/ogg.

source

pub const FLAC: MediaType = _

Media Type for FLAC: audio/flac.

source

pub const WAV: MediaType = _

Media Type for WAV: audio/wav.

source

pub const PDF: MediaType = _

Media Type for PDF: application/pdf.

source

pub const TTF: MediaType = _

Media Type for TTF: application/font-sfnt.

source

pub const OTF: MediaType = _

Media Type for OTF: application/font-sfnt.

source

pub const WOFF: MediaType = _

Media Type for WOFF: application/font-woff.

source

pub const WOFF2: MediaType = _

Media Type for WOFF2: font/woff2.

source

pub const JsonApi: MediaType = _

Media Type for JSON API: application/vnd.api+json.

source

pub const WASM: MediaType = _

Media Type for WASM: application/wasm.

source

pub const TIFF: MediaType = _

Media Type for TIFF: image/tiff.

source

pub const AAC: MediaType = _

Media Type for AAC Audio: audio/aac.

source

pub const Calendar: MediaType = _

Media Type for iCalendar: text/calendar.

source

pub const MPEG: MediaType = _

Media Type for MPEG Video: video/mpeg.

source

pub const TAR: MediaType = _

Media Type for tape archive: application/x-tar.

source

pub const GZIP: MediaType = _

Media Type for gzipped binary: application/gzip.

source

pub const MOV: MediaType = _

Media Type for quicktime video: video/quicktime.

source

pub const MP3: MediaType = _

Media Type for MPEG Audio: audio/mpeg.

source

pub const MP4: MediaType = _

Media Type for MPEG4 Video: video/mp4.

source

pub const ZIP: MediaType = _

Media Type for ZIP archive: application/zip.

source

pub const CBZ: MediaType = _

Media Type for Comic ZIP archive: application/vnd.comicbook+zip.

source

pub const CBR: MediaType = _

Media Type for Comic RAR compressed archive: application/vnd.comicbook-rar.

source

pub const RAR: MediaType = _

Media Type for RAR compressed archive: application/vnd.rar.

source

pub const EPUB: MediaType = _

Media Type for EPUB: application/epub+zip.

source

pub const EventStream: MediaType = _

Media Type for SSE stream: text/event-stream.

source

pub const Markdown: MediaType = _

Media Type for markdown text: text/markdown; charset=utf-8.

source

pub const EXE: MediaType = _

Media Type for executable: application/vnd.microsoft.portable-executable.

source

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.

source

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 , i. e */*.

source

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 , i. e application/octet-stream.

source

pub fn is_bytes(&self) -> bool

Returns true if the top-level and sublevel types of self are the same as those of MediaType::Bytes , i. e application/octet-stream.

source

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 , i. e text/html; charset=utf-8.

source

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 , i. e text/plain; charset=utf-8.

source

pub fn is_text(&self) -> bool

Returns true if the top-level and sublevel types of self are the same as those of MediaType::Text , i. e text/plain; charset=utf-8.

source

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 , i. e application/json.

source

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 , i. e application/msgpack.

source

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 , i. e application/x-www-form-urlencoded.

source

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 , i. e text/javascript.

source

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 , i. e text/css; charset=utf-8.

source

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 , i. e multipart/form-data.

source

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 , i. e text/xml; charset=utf-8.

source

pub fn is_opf(&self) -> bool

Returns true if the top-level and sublevel types of self are the same as those of MediaType::OPF , i. e application/oebps-package+xml.

source

pub fn is_xhtml(&self) -> bool

Returns true if the top-level and sublevel types of self are the same as those of MediaType::XHTML , i. e application/xhtml+xml.

source

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 , i. e text/csv; charset=utf-8.

source

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 , i. e image/png.

source

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 , i. e image/gif.

source

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 , i. e image/bmp.

source

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 , i. e image/jpeg.

source

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 , i. e image/webp.

source

pub fn is_avif(&self) -> bool

Returns true if the top-level and sublevel types of self are the same as those of MediaType::AVIF , i. e image/avif.

source

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 , i. e image/svg+xml.

source

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 , i. e image/x-icon.

source

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 , i. e video/webm.

source

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 , i. e audio/webm.

source

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 , i. e video/ogg.

source

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 , i. e audio/flac.

source

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 , i. e audio/wav.

source

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 , i. e application/pdf.

source

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 , i. e application/font-sfnt.

source

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 , i. e application/font-sfnt.

source

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 , i. e application/font-woff.

source

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 , i. e font/woff2.

source

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 , i. e application/vnd.api+json.

source

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 , i. e application/wasm.

source

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 , i. e image/tiff.

source

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 , i. e audio/aac.

source

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 , i. e text/calendar.

source

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 , i. e video/mpeg.

source

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 , i. e application/x-tar.

source

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 , i. e application/gzip.

source

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 , i. e video/quicktime.

source

pub fn is_mp3(&self) -> bool

Returns true if the top-level and sublevel types of self are the same as those of MediaType::MP3 , i. e audio/mpeg.

source

pub fn is_mp4(&self) -> bool

Returns true if the top-level and sublevel types of self are the same as those of MediaType::MP4 , i. e video/mp4.

source

pub fn is_zip(&self) -> bool

Returns true if the top-level and sublevel types of self are the same as those of MediaType::ZIP , i. e application/zip.

source

pub fn is_cbz(&self) -> bool

Returns true if the top-level and sublevel types of self are the same as those of MediaType::CBZ , i. e application/vnd.comicbook+zip.

source

pub fn is_cbr(&self) -> bool

Returns true if the top-level and sublevel types of self are the same as those of MediaType::CBR , i. e application/vnd.comicbook-rar.

source

pub fn is_rar(&self) -> bool

Returns true if the top-level and sublevel types of self are the same as those of MediaType::RAR , i. e application/vnd.rar.

source

pub fn is_epub(&self) -> bool

Returns true if the top-level and sublevel types of self are the same as those of MediaType::EPUB , i. e application/epub+zip.

source

pub fn is_event_stream(&self) -> bool

Returns true if the top-level and sublevel types of self are the same as those of MediaType::EventStream , i. e text/event-stream.

source

pub fn is_markdown(&self) -> bool

Returns true if the top-level and sublevel types of self are the same as those of MediaType::Markdown , i. e text/markdown; charset=utf-8.

source

pub fn is_exe(&self) -> bool

Returns true if the top-level and sublevel types of self are the same as those of MediaType::EXE , i. e application/vnd.microsoft.portable-executable.

Trait Implementations§

source§

impl Clone for MediaType

source§

fn clone(&self) -> MediaType

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for MediaType

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for MediaType

source§

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

Formats the value using the given formatter. Read more
source§

impl From<MediaType> for ContentType

source§

fn from(media_type: MediaType) -> ContentType

Converts to this type from the input type.
source§

impl From<MediaType> for QMediaType

source§

fn from(media_type: MediaType) -> QMediaType

Converts to this type from the input type.
source§

impl FromStr for MediaType

§

type Err = String

The associated error which can be returned from parsing.
source§

fn from_str(raw: &str) -> Result<MediaType, String>

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

impl Hash for MediaType

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

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

impl PartialEq<MediaType> for MediaType

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Eq for MediaType

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoCollection<T> for T

source§

fn into_collection<A>(self) -> SmallVec<A>where A: Array<Item = T>,

Converts self into a collection.
source§

fn mapped<U, F, A>(self, f: F) -> SmallVec<A>where F: FnMut(T) -> U, A: Array<Item = U>,

source§

impl<T> Paint for Twhere T: ?Sized,

source§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
source§

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to Color::Primary.

Example
println!("{}", value.primary());
source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to Color::Fixed.

Example
println!("{}", value.fixed(color));
source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to Color::Rgb.

Example
println!("{}", value.rgb(r, g, b));
source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to Color::Black.

Example
println!("{}", value.black());
source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to Color::Red.

Example
println!("{}", value.red());
source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to Color::Green.

Example
println!("{}", value.green());
source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::Yellow.

Example
println!("{}", value.yellow());
source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::Blue.

Example
println!("{}", value.blue());
source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::Magenta.

Example
println!("{}", value.magenta());
source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::Cyan.

Example
println!("{}", value.cyan());
source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to Color::White.

Example
println!("{}", value.white());
source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlack.

Example
println!("{}", value.bright_black());
source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightRed.

Example
println!("{}", value.bright_red());
source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightGreen.

Example
println!("{}", value.bright_green());
source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightYellow.

Example
println!("{}", value.bright_yellow());
source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlue.

Example
println!("{}", value.bright_blue());
source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightMagenta.

Example
println!("{}", value.bright_magenta());
source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightCyan.

Example
println!("{}", value.bright_cyan());
source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightWhite.

Example
println!("{}", value.bright_white());
source§

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
source§

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to Color::Primary.

Example
println!("{}", value.on_primary());
source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to Color::Fixed.

Example
println!("{}", value.on_fixed(color));
source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to Color::Rgb.

Example
println!("{}", value.on_rgb(r, g, b));
source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::Black.

Example
println!("{}", value.on_black());
source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::Red.

Example
println!("{}", value.on_red());
source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::Green.

Example
println!("{}", value.on_green());
source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::Yellow.

Example
println!("{}", value.on_yellow());
source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::Blue.

Example
println!("{}", value.on_blue());
source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::Magenta.

Example
println!("{}", value.on_magenta());
source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::Cyan.

Example
println!("{}", value.on_cyan());
source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::White.

Example
println!("{}", value.on_white());
source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightBlack.

Example
println!("{}", value.on_bright_black());
source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightRed.

Example
println!("{}", value.on_bright_red());
source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightGreen.

Example
println!("{}", value.on_bright_green());
source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightYellow.

Example
println!("{}", value.on_bright_yellow());
source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightBlue.

Example
println!("{}", value.on_bright_blue());
source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightMagenta.

Example
println!("{}", value.on_bright_magenta());
source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightCyan.

Example
println!("{}", value.on_bright_cyan());
source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightWhite.

Example
println!("{}", value.on_bright_white());
source§

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
source§

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Bold.

Example
println!("{}", value.bold());
source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Dim.

Example
println!("{}", value.dim());
source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Italic.

Example
println!("{}", value.italic());
source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Underline.

Example
println!("{}", value.underline());

Returns self with the attr() set to Attribute::Blink.

Example
println!("{}", value.blink());

Returns self with the attr() set to Attribute::RapidBlink.

Example
println!("{}", value.rapid_blink());
source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Invert.

Example
println!("{}", value.invert());
source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Conceal.

Example
println!("{}", value.conceal());
source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Strike.

Example
println!("{}", value.strike());
source§

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
source§

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Mask.

Example
println!("{}", value.mask());
source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Wrap.

Example
println!("{}", value.wrap());
source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Linger.

Example
println!("{}", value.linger());
source§

fn clear(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Clear.

Example
println!("{}", value.clear());
source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Bright.

Example
println!("{}", value.bright());
source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::OnBright.

Example
println!("{}", value.on_bright());
source§

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
source§

fn new(self) -> Painted<Self>where Self: Sized,

Create a new Painted with a default Style. Read more
source§

fn paint<S>(&self, style: S) -> Painted<&Self>where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more