impl Effects

const BOLD: Self = _;

const DIMMED: Self = _;

const ITALIC: Self = _;

Not widely supported. Sometimes treated as inverse or blink

const UNDERLINE: Self = _;

Style extensions exist for Kitty, VTE, mintty and iTerm2.

const DOUBLE_UNDERLINE: Self = _;

const CURLY_UNDERLINE: Self = _;

const DOTTED_UNDERLINE: Self = _;

const DASHED_UNDERLINE: Self = _;

const BLINK: Self = _;

const INVERT: Self = _;

Swap foreground and background colors; inconsistent emulation

const HIDDEN: Self = _;

const STRIKETHROUGH: Self = _;

Characters legible but marked as if for deletion. Not supported in Terminal.app

const fn new() -> Self

No effects enabled

Examples

let effects = anstyle::Effects::new();

const fn is_plain(self) -> bool

Check if no effects are enabled

Examples

let effects = anstyle::Effects::new();
assert!(effects.is_plain());

let effects = anstyle::Effects::BOLD | anstyle::Effects::UNDERLINE;
assert!(!effects.is_plain());

const fn contains(self, other: Effects) -> bool

Returns true if all of the effects in other are contained within self.

Examples

let effects = anstyle::Effects::BOLD | anstyle::Effects::UNDERLINE;
assert!(effects.contains(anstyle::Effects::BOLD));

let effects = anstyle::Effects::new();
assert!(!effects.contains(anstyle::Effects::BOLD));

const fn insert(self, other: Effects) -> Self

Inserts the specified effects in-place.

Examples

let effects = anstyle::Effects::new().insert(anstyle::Effects::new());
assert!(effects.is_plain());

let effects = anstyle::Effects::new().insert(anstyle::Effects::BOLD);
assert!(effects.contains(anstyle::Effects::BOLD));

const fn remove(self, other: Effects) -> Self

Removes the specified effects in-place.

Examples

let effects = (anstyle::Effects::BOLD | anstyle::Effects::UNDERLINE).remove(anstyle::Effects::BOLD);
assert!(!effects.contains(anstyle::Effects::BOLD));
assert!(effects.contains(anstyle::Effects::UNDERLINE));

const fn clear(self) -> Self

Reset all effects in-place

let effects = (anstyle::Effects::BOLD | anstyle::Effects::UNDERLINE).clear();
assert!(!effects.contains(anstyle::Effects::BOLD));
assert!(!effects.contains(anstyle::Effects::UNDERLINE));

const fn set(self, other: Self, enable: bool) -> Self

Enable or disable the specified effects depending on the passed value.

Examples

let effects = anstyle::Effects::new().set(anstyle::Effects::BOLD, true);
assert!(effects.contains(anstyle::Effects::BOLD));

fn iter(self) -> EffectIter

Iterate over enabled effects

fn render(self) -> impl Display + Copy

Render the ANSI code