Struct anstyle::Effects

source ·
pub struct Effects(/* private fields */);
Expand description

A set of text effects

§Examples

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

Implementations§

source§

impl Effects

source

pub const BOLD: Self = _

source

pub const DIMMED: Self = _

source

pub const ITALIC: Self = _

Not widely supported. Sometimes treated as inverse or blink

source

pub const UNDERLINE: Self = _

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

source

pub const DOUBLE_UNDERLINE: Self = _

source

pub const CURLY_UNDERLINE: Self = _

source

pub const DOTTED_UNDERLINE: Self = _

source

pub const DASHED_UNDERLINE: Self = _

source

pub const INVERT: Self = _

Swap foreground and background colors; inconsistent emulation

source

pub const HIDDEN: Self = _

source

pub const STRIKETHROUGH: Self = _

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

source

pub const fn new() -> Self

No effects enabled

§Examples
let effects = anstyle::Effects::new();
source

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

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

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

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

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

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

pub fn iter(self) -> EffectIter

Iterate over enabled effects

source

pub fn render(self) -> impl Display

Render the ANSI code

Trait Implementations§

source§

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.
source§

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

Performs the | operation. Read more
source§

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.
source§

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

Performs the | operation. Read more
source§

impl BitOrAssign<Effects> for Style

§Examples

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

fn bitor_assign(&mut self, other: Effects)

Performs the |= operation. Read more
source§

impl BitOrAssign for Effects

§Examples

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

fn bitor_assign(&mut self, other: Self)

Performs the |= operation. Read more
source§

impl Clone for Effects

source§

fn clone(&self) -> Effects

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
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)");
source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Effects

source§

fn default() -> Effects

Returns the “default value” for a type. Read more
source§

impl From<Effects> for Style

§Examples

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

fn from(effects: Effects) -> Self

Converts to this type from the input type.
source§

impl Hash for Effects

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

source§

fn cmp(&self, other: &Effects) -> 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 + PartialOrd,

Restrict a value to a certain interval. Read more
source§

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

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

impl PartialEq for Effects

source§

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

impl PartialOrd for Effects

source§

fn partial_cmp(&self, other: &Effects) -> 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

This method 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

This method 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

This method 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

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

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.
source§

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

Performs the - operation. Read more
source§

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.
source§

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

Performs the - operation. Read more
source§

impl SubAssign<Effects> for Style

§Examples

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

fn sub_assign(&mut self, other: Effects)

Performs the -= operation. Read more
source§

impl SubAssign for Effects

§Examples

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

fn sub_assign(&mut self, other: Self)

Performs the -= operation. Read more
source§

impl Copy for Effects

source§

impl Eq for Effects

source§

impl StructuralPartialEq for Effects

Auto Trait Implementations§

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> 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> 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> ToOwned for T
where T: Clone,

§

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

§

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

§

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.