Struct mhost::app::output::styles::OK

pub struct OK { /* private fields */ }

Methods from Deref<Target = Style>

pub fn fg_color(&self) -> Color

Returns the foreground color of self.

use yansi::{Style, Color};

let plain = Style::default();
assert_eq!(plain.fg_color(), Color::Unset);

let red = plain.fg(Color::Red);
assert_eq!(red.fg_color(), Color::Red);

pub fn bg_color(&self) -> Color

Returns the foreground color of self.

use yansi::{Style, Color};

let plain = Style::default();
assert_eq!(plain.bg_color(), Color::Unset);

let white = plain.bg(Color::White);
assert_eq!(white.bg_color(), Color::White);

pub fn is_masked(&self) -> bool

Returns true if self is masked.

use yansi::Style;

let plain = Style::default();
assert!(!plain.is_masked());

let masked = plain.mask();
assert!(masked.is_masked());

pub fn is_wrapping(&self) -> bool

Returns true if self is wrapping.

use yansi::Style;

let plain = Style::default();
assert!(!plain.is_wrapping());

let wrapping = plain.wrap();
assert!(wrapping.is_wrapping());

pub fn is_bold(&self) -> bool

Returns true if the bold property is set on self.

use yansi::Style;

let plain = Style::default();
assert!(!plain.is_bold());

let styled = plain.bold();
assert!(styled.is_bold());

pub fn is_dimmed(&self) -> bool

Returns true if the dimmed property is set on self.

use yansi::Style;

let plain = Style::default();
assert!(!plain.is_dimmed());

let styled = plain.dimmed();
assert!(styled.is_dimmed());

pub fn is_italic(&self) -> bool

Returns true if the italic property is set on self.

use yansi::Style;

let plain = Style::default();
assert!(!plain.is_italic());

let styled = plain.italic();
assert!(styled.is_italic());

pub fn is_underline(&self) -> bool

Returns true if the underline property is set on self.

use yansi::Style;

let plain = Style::default();
assert!(!plain.is_underline());

let styled = plain.underline();
assert!(styled.is_underline());

pub fn is_blink(&self) -> bool

Returns true if the blink property is set on self.

use yansi::Style;

let plain = Style::default();
assert!(!plain.is_blink());

let styled = plain.blink();
assert!(styled.is_blink());

pub fn is_invert(&self) -> bool

Returns true if the invert property is set on self.

use yansi::Style;

let plain = Style::default();
assert!(!plain.is_invert());

let styled = plain.invert();
assert!(styled.is_invert());

pub fn is_hidden(&self) -> bool

Returns true if the hidden property is set on self.

use yansi::Style;

let plain = Style::default();
assert!(!plain.is_hidden());

let styled = plain.hidden();
assert!(styled.is_hidden());

pub fn is_strikethrough(&self) -> bool

Returns true if the strikethrough property is set on self.

use yansi::Style;

let plain = Style::default();
assert!(!plain.is_strikethrough());

let styled = plain.strikethrough();
assert!(styled.is_strikethrough());

pub fn fmt_prefix(&self, f: &mut dyn Write) -> Result<(), Error>

Writes the ANSI code prefix for the currently set styles.

This method is intended to be used inside of fmt::Display and fmt::Debug implementations for custom or specialized use-cases. Most users should use Paint for all painting needs.

This method writes the ANSI code prefix irrespective of whether painting is currently enabled or disabled. To write the prefix only if painting is enabled, condition a call to this method on Paint::is_enabled().

Example

use std::fmt;
use yansi::Style;

struct CustomItem {
    item: u32,
    style: Style
}

impl fmt::Display for CustomItem {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        self.style.fmt_prefix(f)?;
        write!(f, "number: {}", self.item)?;
        self.style.fmt_suffix(f)
    }
}

pub fn fmt_suffix(&self, f: &mut dyn Write) -> Result<(), Error>

Writes the ANSI code suffix for the currently set styles.

This method is intended to be used inside of fmt::Display and fmt::Debug implementations for custom or specialized use-cases. Most users should use Paint for all painting needs.

This method writes the ANSI code suffix irrespective of whether painting is currently enabled or disabled. To write the suffix only if painting is enabled, condition a call to this method on Paint::is_enabled().

Example

use std::fmt;
use yansi::Style;

struct CustomItem {
    item: u32,
    style: Style
}

impl fmt::Display for CustomItem {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        self.style.fmt_prefix(f)?;
        write!(f, "number: {}", self.item)?;
        self.style.fmt_suffix(f)
    }
}

Trait Implementations

impl Deref for OK

type Target = Style

The resulting type after dereferencing.

fn deref(&self) -> &Style

Dereferences the value.

impl LazyStatic for OK