Enum yansi::Quirk

pub enum Quirk {
    Mask,
    Wrap,
    Linger,
    Clear,
    Resetting,
    Bright,
    OnBright,
}

Enum representing a yansi quirk.

See the crate level docs for details.

Variants

Mask

Mask: omit when painting is disabled.

Typically applied via the mask() builder method.

See the crate level docs for details.

Wrap

Wrap the value: replace resets with the wrapped styling.

Typically applied via the wrap() builder method.

See the crate level docs for details.

Linger

Linger: do not reset the style after it is applied.

Typically applied via the linger() builder method.

See the crate level docs for details.

Clear

👎Deprecated since 1.0.1: renamed to Resetting due to builder method conflicts with Vec::clear(). Quirk::Clear will be removed in a future release.

Deprecated: Use Quirk::Resetting instead.

Resetting

Always reset styling afterwards, even if no actual styling was applied.

Overrides the Linger quirk if present.

Typically applied via the resetting() builder method.

Bright

Brighten the foreground color if it is not already bright.

Typically applied via the bright() builder method.

See the crate level docs for details.

OnBright

Brighten the background color if it is not already bright.

Typically applied via the on_bright() builder method.

See the crate level docs for details.

Implementations

impl Quirk

pub const fn style(self) -> Style

Returns a Style with the quirk self enabled.

Example

use yansi::{Style, Quirk::Mask};

static MASKED: Style = Mask.style();

Trait Implementations

impl Clone for Quirk

fn clone(&self) -> Quirk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Quirk

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

Formats the value using the given formatter.

impl From<Quirk> for Style

fn from(quirk: Quirk) -> Self

Converts to this type from the input type.

impl Hash for Quirk

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

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 Quirk

fn cmp(&self, other: &Quirk) -> 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 for Quirk

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

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

impl Eq for Quirk

impl StructuralPartialEq for Quirk