Struct Feature

Source
pub struct Feature<'f>(/* private fields */);

Methods from Deref<Target = Cow<'f, str>>ยง

Source

pub fn is_borrowed(&self) -> bool

๐Ÿ”ฌThis is a nightly-only experimental API. (cow_is_borrowed)

Returns true if the data is borrowed, i.e. if to_mut would require additional work.

ยงExamples
#![feature(cow_is_borrowed)]
use std::borrow::Cow;

let cow = Cow::Borrowed("moo");
assert!(cow.is_borrowed());

let bull: Cow<'_, str> = Cow::Owned("...moo?".to_string());
assert!(!bull.is_borrowed());
Source

pub fn is_owned(&self) -> bool

๐Ÿ”ฌThis is a nightly-only experimental API. (cow_is_borrowed)

Returns true if the data is owned, i.e. if to_mut would be a no-op.

ยงExamples
#![feature(cow_is_borrowed)]
use std::borrow::Cow;

let cow: Cow<'_, str> = Cow::Owned("moo".to_string());
assert!(cow.is_owned());

let bull = Cow::Borrowed("...moo?");
assert!(!bull.is_owned());
1.0.0 ยท Source

pub fn to_mut(&mut self) -> &mut <B as ToOwned>::Owned

Acquires a mutable reference to the owned form of the data.

Clones the data if it is not already owned.

ยงExamples
use std::borrow::Cow;

let mut cow = Cow::Borrowed("foo");
cow.to_mut().make_ascii_uppercase();

assert_eq!(
  cow,
  Cow::Owned(String::from("FOO")) as Cow<'_, str>
);

Trait Implementationsยง

Sourceยง

impl<'f, __AsT: ?Sized> AsMut<__AsT> for Feature<'f>
where Cow<'f, str>: AsMut<__AsT>,

Sourceยง

fn as_mut(&mut self) -> &mut __AsT

Converts this type into a mutable reference of the (usually inferred) input type.
Sourceยง

impl<'f, __AsT: ?Sized> AsRef<__AsT> for Feature<'f>
where Cow<'f, str>: AsRef<__AsT>,

Sourceยง

fn as_ref(&self) -> &__AsT

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

impl<'f> Clone for Feature<'f>

Sourceยง

fn clone(&self) -> Feature<'f>

Returns a duplicate 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<'f> Debug for Feature<'f>

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl<'f> DerefMut for Feature<'f>

Sourceยง

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
Sourceยง

impl<'de, 'f> Deserialize<'de> for Feature<'f>

Sourceยง

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Sourceยง

impl Display for Feature<'_>

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl From<String> for Feature<'static>

Sourceยง

fn from(s: String) -> Self

Converts to this type from the input type.
Sourceยง

impl<'f> FromIterator<Feature<'f>> for FeatureSet<'f>

Sourceยง

fn from_iter<T: IntoIterator<Item = Feature<'f>>>(iter: T) -> Self

Creates a value from an iterator. Read more
Sourceยง

impl<'f> Hash for Feature<'f>

Sourceยง

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

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<'f> Ord for Feature<'f>

Sourceยง

fn cmp(&self, other: &Feature<'f>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 ยท Sourceยง

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

Compares and returns the maximum of two values. Read more
1.21.0 ยท Sourceยง

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

Compares and returns the minimum of two values. Read more
1.50.0 ยท Sourceยง

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

Restrict a value to a certain interval. Read more
Sourceยง

impl<'f> PartialEq for Feature<'f>

Sourceยง

fn eq(&self, other: &Feature<'f>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 ยท Sourceยง

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Sourceยง

impl<'f> PartialOrd for Feature<'f>

Sourceยง

fn partial_cmp(&self, other: &Feature<'f>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 ยท Sourceยง

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 ยท Sourceยง

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 ยท Sourceยง

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 ยท Sourceยง

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

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

impl<'f> Serialize for Feature<'f>

Sourceยง

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Sourceยง

impl<'f> Deref for Feature<'f>

Sourceยง

type Target = Cow<'f, str>

The resulting type after dereferencing.
Sourceยง

fn deref(&self) -> &Self::Target

Dereferences the value.
Sourceยง

impl<'f> Eq for Feature<'f>

Sourceยง

impl<'f> StructuralPartialEq for Feature<'f>

Auto Trait Implementationsยง

ยง

impl<'f> Freeze for Feature<'f>

ยง

impl<'f> RefUnwindSafe for Feature<'f>

ยง

impl<'f> Send for Feature<'f>

ยง

impl<'f> Sync for Feature<'f>

ยง

impl<'f> Unpin for Feature<'f>

ยง

impl<'f> UnwindSafe for Feature<'f>

Blanket Implementationsยง

Sourceยง

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

Sourceยง

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Sourceยง

impl<T> AsUncased for T
where T: AsRef<str> + ?Sized,

Sourceยง

fn as_uncased(&self) -> &UncasedStr

Convert self to an UncasedStr.
Sourceยง

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

Sourceยง

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Sourceยง

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

Sourceยง

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

Mutably borrows from an owned value. Read more
Sourceยง

impl<T> CloneToUninit for T
where T: Clone,

Sourceยง

unsafe fn clone_to_uninit(&self, dest: *mut u8)

๐Ÿ”ฌThis is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Sourceยง

impl<T> From<T> for T

Sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

Sourceยง

impl<T, U> Into<U> for T
where 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> IntoEither for T

Sourceยง

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Sourceยง

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Sourceยง

impl<T> Paint for T
where 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>

๐Ÿ‘ŽDeprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

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

ยงExample
println!("{}", value.clear());
Sourceยง

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

Returns self with the quirk() set to [Quirk :: Resetting].

ยงExample
println!("{}", value.resetting());
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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Sourceยง

type Target = T

๐Ÿ”ฌThis is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Sourceยง

impl<T> ToOwned for T
where T: Clone,

Sourceยง

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 T
where T: Display + ?Sized,

Sourceยง

fn to_string(&self) -> String

Converts the given value to a String. Read more
Sourceยง

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

Sourceยง

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 T
where U: TryFrom<T>,

Sourceยง

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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,