Struct clap::builder::styling::Effects

pub struct Effects(/* private fields */);

A set of text effects

Examples

let effects = anstyle::Effects::BOLD | anstyle::Effects::UNDERLINE;

Implementations

impl Effects

pub const BOLD: Effects = _

pub const DIMMED: Effects = _

pub const ITALIC: Effects = _

Not widely supported. Sometimes treated as inverse or blink

pub const UNDERLINE: Effects = _

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

pub const DOUBLE_UNDERLINE: Effects = _

pub const CURLY_UNDERLINE: Effects = _

pub const DOTTED_UNDERLINE: Effects = _

pub const DASHED_UNDERLINE: Effects = _

pub const BLINK: Effects = _

pub const INVERT: Effects = _

Swap foreground and background colors; inconsistent emulation

pub const HIDDEN: Effects = _

pub const STRIKETHROUGH: Effects = _

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

pub const fn new() -> Effects

No effects enabled

Examples

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

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

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

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

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

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

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

pub const fn clear(self) -> Effects

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

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

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

pub fn iter(self) -> EffectIter

Iterate over enabled effects

pub fn render(self) -> impl Display

Render the ANSI code

Trait Implementations

impl BitOr<Effects> for Style

Examples

let style = anstyle::Style::new() | anstyle::Effects::BOLD.into();

type Output = Style

The resulting type after applying the | operator.

fn bitor(self, rhs: Effects) -> Style

Performs the | operation.

impl BitOr for Effects

Examples

let effects = anstyle::Effects::BOLD | anstyle::Effects::UNDERLINE;
assert_eq!(format!("{:?}", effects), "Effects(BOLD | UNDERLINE)");

type Output = Effects

The resulting type after applying the | operator.

fn bitor(self, rhs: Effects) -> Effects

Performs the | operation.

impl BitOrAssign<Effects> for Style

Examples

let mut style = anstyle::Style::new();
style |= anstyle::Effects::BOLD.into();

fn bitor_assign(&mut self, other: Effects)

Performs the |= operation.

impl BitOrAssign for Effects

Examples

let mut effects = anstyle::Effects::BOLD;
effects |= anstyle::Effects::UNDERLINE;
assert_eq!(format!("{:?}", effects), "Effects(BOLD | UNDERLINE)");

fn bitor_assign(&mut self, other: Effects)

Performs the |= operation.

impl Clone for Effects

fn clone(&self) -> Effects

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Effects

Examples

let effects = anstyle::Effects::new();
assert_eq!(format!("{:?}", effects), "Effects()");

let effects = anstyle::Effects::BOLD | anstyle::Effects::UNDERLINE;
assert_eq!(format!("{:?}", effects), "Effects(BOLD | UNDERLINE)");

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

Formats the value using the given formatter.

impl Default for Effects

fn default() -> Effects

Returns the “default value” for a type.

impl From<Effects> for Style

Examples

let style: anstyle::Style = anstyle::Effects::BOLD.into();

fn from(effects: Effects) -> Style

Converts to this type from the input type.

impl Hash for Effects

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

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Effects

fn cmp(&self, other: &Effects) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<Effects> for Style

Examples

let effects = anstyle::Effects::BOLD;
assert_eq!(anstyle::Style::new().effects(effects), effects);
assert_ne!(anstyle::Effects::UNDERLINE | effects, effects);
assert_ne!(anstyle::RgbColor(0, 0, 0).on_default() | effects, effects);

fn eq(&self, other: &Effects) -> bool

This method tests for self and other values to be equal, and is used by ==.

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 PartialEq for Effects

fn eq(&self, other: &Effects) -> bool

This method tests for self and other values to be equal, and is used by ==.

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 PartialOrd for Effects

fn partial_cmp(&self, other: &Effects) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<Effects> for Style

Examples

let style = anstyle::Style::new().bold().underline() - anstyle::Effects::BOLD.into();

type Output = Style

The resulting type after applying the - operator.

fn sub(self, other: Effects) -> Style

Performs the - operation.

impl Sub for Effects

Examples

let effects = (anstyle::Effects::BOLD | anstyle::Effects::UNDERLINE) - anstyle::Effects::BOLD;
assert_eq!(format!("{:?}", effects), "Effects(UNDERLINE)");

type Output = Effects

The resulting type after applying the - operator.

fn sub(self, other: Effects) -> Effects

Performs the - operation.

impl SubAssign<Effects> for Style

Examples

let mut style = anstyle::Style::new().bold().underline();
style -= anstyle::Effects::BOLD.into();

fn sub_assign(&mut self, other: Effects)

Performs the -= operation.

impl SubAssign for Effects

Examples

let mut effects = anstyle::Effects::BOLD | anstyle::Effects::UNDERLINE;
effects -= anstyle::Effects::BOLD;
assert_eq!(format!("{:?}", effects), "Effects(UNDERLINE)");

fn sub_assign(&mut self, other: Effects)

Performs the -= operation.

impl Copy for Effects

impl Eq for Effects

impl StructuralPartialEq for Effects