Struct rocket::http::ContentType

Returns the most common file extension associated with the Content-Type self if it is known. Otherwise, returns None . The currently recognized extensions are identical to those in ContentType::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::ContentType;

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

An unknown extension:

use rocket::http::ContentType;

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

pub const Any: ContentType = _

Content Type for any media type: */*.

pub const Binary: ContentType = _

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

pub const Bytes: ContentType = _

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

pub const HTML: ContentType = _

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

pub const Plain: ContentType = _

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

pub const Text: ContentType = _

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

pub const JSON: ContentType = _

Content Type for JSON: application/json.

pub const MsgPack: ContentType = _

Content Type for MsgPack: application/msgpack.

pub const Form: ContentType = _

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

pub const JavaScript: ContentType = _

Content Type for JavaScript: text/javascript.

pub const CSS: ContentType = _

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

pub const FormData: ContentType = _

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

pub const XML: ContentType = _

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

pub const OPF: ContentType = _

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

pub const XHTML: ContentType = _

Content Type for XHTML: application/xhtml+xml.

pub const CSV: ContentType = _

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

pub const PNG: ContentType = _

Content Type for PNG: image/png.

pub const GIF: ContentType = _

Content Type for GIF: image/gif.

pub const BMP: ContentType = _

Content Type for BMP: image/bmp.

pub const JPEG: ContentType = _

Content Type for JPEG: image/jpeg.

pub const WEBP: ContentType = _

Content Type for WEBP: image/webp.

pub const AVIF: ContentType = _

Content Type for AVIF: image/avif.

pub const SVG: ContentType = _

Content Type for SVG: image/svg+xml.

pub const Icon: ContentType = _

Content Type for Icon: image/x-icon.

pub const WEBM: ContentType = _

Content Type for WEBM: video/webm.

pub const WEBA: ContentType = _

Content Type for WEBM Audio: audio/webm.

pub const OGG: ContentType = _

Content Type for OGG Video: video/ogg.

pub const FLAC: ContentType = _

Content Type for FLAC: audio/flac.

pub const WAV: ContentType = _

Content Type for WAV: audio/wav.

pub const PDF: ContentType = _

Content Type for PDF: application/pdf.

pub const TTF: ContentType = _

Content Type for TTF: application/font-sfnt.

pub const OTF: ContentType = _

Content Type for OTF: application/font-sfnt.

pub const WOFF: ContentType = _

Content Type for WOFF: application/font-woff.

pub const WOFF2: ContentType = _

Content Type for WOFF2: font/woff2.

pub const JsonApi: ContentType = _

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

pub const WASM: ContentType = _

Content Type for WASM: application/wasm.

pub const TIFF: ContentType = _

Content Type for TIFF: image/tiff.

pub const AAC: ContentType = _

Content Type for AAC Audio: audio/aac.

pub const Calendar: ContentType = _

Content Type for iCalendar: text/calendar.

pub const MPEG: ContentType = _

Content Type for MPEG Video: video/mpeg.

pub const TAR: ContentType = _

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

pub const GZIP: ContentType = _

Content Type for gzipped binary: application/gzip.

pub const MOV: ContentType = _

Content Type for quicktime video: video/quicktime.

pub const MP3: ContentType = _

Content Type for MPEG Audio: audio/mpeg.

pub const MP4: ContentType = _

Content Type for MPEG4 Video: video/mp4.

pub const ZIP: ContentType = _

Content Type for ZIP archive: application/zip.

pub const CBZ: ContentType = _

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

pub const CBR: ContentType = _

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

pub const RAR: ContentType = _

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

pub const EPUB: ContentType = _

Content Type for EPUB: application/epub+zip.

pub const EventStream: ContentType = _

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

pub const Markdown: ContentType = _

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

pub const EXE: ContentType = _

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

Methods from Deref<Target = MediaType>§

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

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

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

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

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>

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

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

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

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

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

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

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.

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.

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.

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

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

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

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

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.

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

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.

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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§

impl Clone for ContentType

fn clone(&self) -> ContentType

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

impl Debug for ContentType

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

Formats the value using the given formatter. Read more

impl Default for ContentType

fn default() -> ContentType

Returns a ContentType of Any, or */*.

impl Deref for ContentType

type Target = MediaType

The resulting type after dereferencing.

fn deref(&self) -> &MediaType

Dereferences the value.

impl Display for ContentType

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

Formats the ContentType as an HTTP Content-Type value.

Example

use rocket::http::ContentType;

let ct = format!("{}", ContentType::JSON);
assert_eq!(ct, "application/json");

impl From<ContentType> for Header<'static>

Creates a new Header with name Content-Type and the value set to the HTTP rendering of this Content-Type.

fn from(content_type: ContentType) -> Header<'static>

Converts to this type from the input type.

impl From<MediaType> for ContentType

fn from(media_type: MediaType) -> ContentType

Converts to this type from the input type.

impl<'r> FromRequest<'r> for &'r ContentType

type Error = Infallible

The associated error to be returned if derivation fails.

fn from_request<'life0, 'async_trait>( request: &'r Request<'life0> ) -> Pin<Box<dyn Future<Output = Outcome<Self, Infallible>> + Send + 'async_trait>>where Self: 'async_trait, 'r: 'async_trait, 'life0: 'async_trait,

Derives an instance of Self from the incoming request metadata. Read more

impl FromStr for ContentType

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

Parses a ContentType from a given Content-Type header value.

Examples

Parsing an application/json:

use std::str::FromStr;
use rocket::http::ContentType;

let json = ContentType::from_str("application/json").unwrap();
assert!(json.is_known());
assert_eq!(json, ContentType::JSON);

Parsing a content type extension:

use std::str::FromStr;
use rocket::http::ContentType;

let custom = ContentType::from_str("application/x-custom").unwrap();
assert!(!custom.is_known());
assert_eq!(custom.top(), "application");
assert_eq!(custom.sub(), "x-custom");

Parsing an invalid Content-Type value:

use std::str::FromStr;
use rocket::http::ContentType;

let custom = ContentType::from_str("application//x-custom");
assert!(custom.is_err());

type Err = String

The associated error which can be returned from parsing.

impl Hash for ContentType

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

impl PartialEq for ContentType

fn eq(&self, other: &ContentType) -> 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.

impl Eq for ContentType

impl StructuralEq for ContentType

impl StructuralPartialEq for ContentType

Auto Trait Implementations§

impl RefUnwindSafe for ContentType

impl Send for ContentType

impl Sync for ContentType

impl Unpin for ContentType

impl UnwindSafe for ContentType

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T> AsTaggedExplicit<'a> for Twhere T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self>

impl<'a, T> AsTaggedImplicit<'a> for Twhere T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self>

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

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

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoCollection<T> for T

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

Converts self into a collection.

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

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

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

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

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

Example

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

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

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

Example

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

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

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

Example

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

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

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

Example

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

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Example

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

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

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

Create a new Painted with a default Style. Read more

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

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

default fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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