Struct MediaType
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§
§impl MediaType
impl MediaType
pub const JavaScript: MediaType = _
pub const JavaScript: MediaType = _
Media Type for
JavaScript:
text/javascript
pub const CBR: MediaType = _
pub const CBR: MediaType = _
Media Type for
Comic RAR compressed archive:
application/vnd.comicbook-rar
pub const EventStream: MediaType = _
pub const EventStream: MediaType = _
Media Type for
SSE stream:
text/event-stream
pub const EXE: MediaType = _
pub const EXE: MediaType = _
Media Type for
executable:
application/vnd.microsoft.portable-executable
pub fn new<T, S>(top: T, sub: S) -> MediaType
pub fn new<T, S>(top: T, sub: S) -> MediaType
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");pub fn with_params<K, V, P>(self, ps: P) -> MediaType
pub fn with_params<K, V, P>(self, ps: P) -> MediaType
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());pub const fn const_new(
top: &'static str,
sub: &'static str,
params: &'static [(&'static str, &'static str)],
) -> MediaType
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");pub fn parse_flexible(name: &str) -> Option<MediaType>
pub fn parse_flexible(name: &str) -> Option<MediaType>
Flexibly parses name into a MediaType. The parse is
flexible because, in addition to strictly correct content 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 MediaType::from_str().
§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);pub fn from_extension(ext: &str) -> Option<MediaType>
pub fn from_extension(ext: &str) -> Option<MediaType>
Returns the Media Type associated with the extension ext.
Extensions are matched case-insensitively. 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.
§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());pub 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");pub 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");pub 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);pub 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 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));pub fn params(&self) -> impl Iterator<Item = (&UncasedStr, &str)>
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);pub fn param<'a>(&'a self, name: &str) -> Option<&'a str>
pub fn param<'a>(&'a self, name: &str) -> Option<&'a str>
Returns the first parameter with name name, if there is any.
pub fn extension(&self) -> Option<&UncasedStr>
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 Content-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());pub 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.
pub 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,
i.e
*/*.
pub 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,
i.e
application/octet-stream.
pub fn is_bytes(&self) -> bool
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.
pub 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,
i.e
text/html.
pub 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,
i.e
text/plain.
pub fn is_text(&self) -> bool
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.
pub 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,
i.e
application/json.
pub 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,
i.e
application/msgpack.
pub 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,
i.e
application/x-www-form-urlencoded.
pub 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,
i.e
text/javascript.
pub 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,
i.e
text/css.
pub 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,
i.e
multipart/form-data.
pub 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,
i.e
text/xml.
pub fn is_opf(&self) -> bool
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.
pub fn is_xhtml(&self) -> bool
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.
pub 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,
i.e
text/csv.
pub 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,
i.e
image/png.
pub 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,
i.e
image/gif.
pub 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,
i.e
image/bmp.
pub 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,
i.e
image/jpeg.
pub 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,
i.e
image/webp.
pub fn is_avif(&self) -> bool
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.
pub 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,
i.e
image/svg+xml.
pub 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,
i.e
image/x-icon.
pub 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,
i.e
video/webm.
pub 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,
i.e
audio/webm.
pub 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,
i.e
video/ogg.
pub 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,
i.e
audio/flac.
pub 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,
i.e
audio/wav.
pub 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,
i.e
application/pdf.
pub 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,
i.e
application/font-sfnt.
pub 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,
i.e
application/font-sfnt.
pub 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,
i.e
application/font-woff.
pub 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,
i.e
font/woff2.
pub 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,
i.e
application/vnd.api+json.
pub 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,
i.e
application/wasm.
pub 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,
i.e
image/tiff.
pub 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,
i.e
audio/aac.
pub 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,
i.e
text/calendar.
pub 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,
i.e
video/mpeg.
pub 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,
i.e
application/x-tar.
pub 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,
i.e
application/gzip.
pub 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,
i.e
video/quicktime.
pub fn is_mp3(&self) -> bool
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.
pub fn is_mp4(&self) -> bool
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.
pub fn is_zip(&self) -> bool
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.
pub fn is_cbz(&self) -> bool
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.
pub fn is_cbr(&self) -> bool
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.
pub fn is_rar(&self) -> bool
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.
pub fn is_epub(&self) -> bool
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.
pub fn is_event_stream(&self) -> bool
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.
pub fn is_markdown(&self) -> bool
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.
Trait Implementations§
§impl From<MediaType> for ContentType
impl From<MediaType> for ContentType
§fn from(media_type: MediaType) -> ContentType
fn from(media_type: MediaType) -> ContentType
§impl From<MediaType> for QMediaType
impl From<MediaType> for QMediaType
§fn from(media_type: MediaType) -> QMediaType
fn from(media_type: MediaType) -> QMediaType
§impl IntoIterator for MediaType
impl IntoIterator for MediaType
impl Eq for MediaType
Auto Trait Implementations§
impl Freeze for MediaType
impl RefUnwindSafe for MediaType
impl Send for MediaType
impl Sync for MediaType
impl Unpin for MediaType
impl UnwindSafe for MediaType
Blanket Implementations§
Source§impl<T> AsAny for Twhere
T: Any,
impl<T> AsAny for Twhere
T: Any,
fn as_any_ref(&self) -> &(dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
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 bright_black(&self) -> Painted<&T>
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>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
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>
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>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
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>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
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>
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>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
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>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
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>
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>
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>
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>
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>
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>
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::Underline.
§Example
println!("{}", value.underline());Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::RapidBlink.
§Example
println!("{}", value.rapid_blink());Source§fn quirk(&self, value: Quirk) -> Painted<&T>
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 clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
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);