Struct Style 

pub struct Style { /* private fields */ }

A structure representing text styling with effects and colors.

Implementations

impl Style

pub const fn new() -> Self

Creates a new, empty Style value.

pub fn set_effect(self, effect: impl Into<Effect>, value: bool) -> Self

Sets the given effect to the specified value.

pub fn get_effect(&self, effect: impl Into<Effect>) -> bool

Gets whether the given effect is set.

pub fn get_effects(&self) -> GetEffects

Returns an iterator over the effects that are currently set.

pub fn set_underline_effect( self, underline_effect: Option<UnderlineEffect>, ) -> Self

Sets the underline effect.

pub fn get_underline_effect(&self) -> Option<UnderlineEffect>

Gets the underline effect.

pub fn set_color( self, target: ColorTarget, color: Option<impl Into<Color>>, ) -> Self

Sets the color for the given color target.

To clear the color for some color target, the color type must be specified in the None value. To help with that, the Color::none() method can be used:

style.set_color(ColorTarget::Foreground, None::<Color>);
// or
style.set_color(ColorTarget::Foreground, Color::none());

pub fn get_color(&self, target: ColorTarget) -> Option<Color>

Gets the color for the given color target.

pub fn set<A: StylingAttribute<Self>>(self, attr: A, value: A::Value) -> Self

Sets the given attribute to the specified value.

pub fn get<A: StylingAttribute<Self>>(&self, attr: A) -> A::Value

Gets the value of the given attribute.

pub fn remove<A: StylingAttribute<Self>>(self, attr: A) -> Self

Clears the given attribute.

impl Style

pub fn bold(self) -> Style

Sets the bold effect.

pub fn faint(self) -> Style

Sets the faint effect.

pub fn italic(self) -> Style

Sets the italic effect.

pub fn underline(self) -> Style

An alias for Self::solid_underline().

pub fn solid_underline(self) -> Style

Sets the solid underline effect.

pub fn curly_underline(self) -> Style

Sets the curly underline effect.

pub fn dotted_underline(self) -> Style

Sets the dotted underline effect.

pub fn dashed_underline(self) -> Style

Sets the dashed underline effect.

pub fn blink(self) -> Style

Sets the blink effect.

pub fn reverse(self) -> Style

Sets the reverse effect.

pub fn conceal(self) -> Style

Sets the conceal effect.

pub fn strikethrough(self) -> Style

Sets the strikethrough effect.

pub fn double_underline(self) -> Style

Sets the double underline effect.

pub fn overline(self) -> Style

Sets the overline effect.

pub fn effect(self, effect: impl Into<Effect>) -> Style

Sets the given effect.

pub fn underline_effect(self, underline_effect: UnderlineEffect) -> Style

Sets the underline effect.

pub fn fg(self, color: impl Into<Color>) -> Style

Sets the foreground color.

pub fn bg(self, color: impl Into<Color>) -> Style

Sets the background color.

pub fn underline_color(self, color: impl Into<Color>) -> Style

Sets the underline color.

pub fn color(self, targeted_color: impl Into<TargetedColor>) -> Style

Sets the given color in a target.

pub fn add(self, element: impl StylingElement<Style>) -> Style

Adds the given element to the style.

pub fn applied_to<C: Display>(self, content: C) -> Styled<C>

Applies the styling to the given content, returning a Styled<C> instance.

impl Style

pub fn to_style(self) -> Style

Convert this type into a Style.

Trait Implementations

impl Clone for Style

fn clone(&self) -> Style

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Style

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

Formats the value using the given formatter.

impl Default for Style

fn default() -> Style

Returns the “default value” for a type.

impl Display for Style

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

Formats the value using the given formatter.

impl From<BasicColor> for Style

fn from(value: BasicColor) -> Self

Converts to this type from the input type.

impl From<Color> for Style

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Effect> for Style

fn from(value: Effect) -> Self

Converts to this type from the input type.

impl From<IndexedColor> for Style

fn from(value: IndexedColor) -> Self

Converts to this type from the input type.

impl From<RGBColor> for Style

fn from(value: RGBColor) -> Self

Converts to this type from the input type.

impl From<Reset> for Style

fn from(value: Reset) -> Self

Converts to this type from the input type.

impl From<SimpleColor> for Style

fn from(value: SimpleColor) -> Self

Converts to this type from the input type.

impl From<TargetedColor> for Style

fn from(value: TargetedColor) -> Self

Converts to this type from the input type.

impl From<UnderlineEffect> for Style

fn from(value: UnderlineEffect) -> Self

Converts to this type from the input type.

impl Hash for Style

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 PartialEq<Reset> for Style

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Style> for Reset

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Style

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StylingAttribute<Style> for ColorTarget

type Value = Option<Color>

The type of value associated with this attribute.

fn set_in(self, composed_styling: Style, value: Self::Value) -> Style

Sets this attribute in the given parameter, returning it updated.

fn get_from(self, composed_styling: &Style) -> Self::Value

Gets the value of this attribute from the given parameter.

impl StylingAttribute<Style> for Effect

type Value = bool

The type of value associated with this attribute.

fn set_in(self, composed_styling: Style, value: Self::Value) -> Style

Sets this attribute in the given parameter, returning it updated.

fn get_from(self, composed_styling: &Style) -> Self::Value

Gets the value of this attribute from the given parameter.

impl StylingAttribute<Style> for UnderlineEffect

type Value = bool

The type of value associated with this attribute.

fn set_in(self, composed_styling: Style, value: Self::Value) -> Style

Sets this attribute in the given parameter, returning it updated.

fn get_from(self, composed_styling: &Style) -> Self::Value

Gets the value of this attribute from the given parameter.

impl StylingAttribute<Style> for UnderlineStyle

type Value = Option<UnderlineEffect>

The type of value associated with this attribute.

fn set_in(self, composed_styling: Style, value: Self::Value) -> Style

Sets this attribute in the given parameter, returning it updated.

fn get_from(self, composed_styling: &Style) -> Self::Value

Gets the value of this attribute from the given parameter.

impl StylingElement<Style> for BasicColor

fn add_to(self, composed_styling: Style) -> Style

Adds this element to the given parameter, returning it updated.

impl StylingElement<Style> for Color

fn add_to(self, composed_styling: Style) -> Style

Adds this element to the given parameter, returning it updated.

impl StylingElement<Style> for Effect

fn add_to(self, composed_styling: Style) -> Style

Adds this element to the given parameter, returning it updated.

impl StylingElement<Style> for IndexedColor

fn add_to(self, composed_styling: Style) -> Style

Adds this element to the given parameter, returning it updated.

impl StylingElement<Style> for RGBColor

fn add_to(self, composed_styling: Style) -> Style

Adds this element to the given parameter, returning it updated.

impl StylingElement<Style> for SimpleColor

fn add_to(self, composed_styling: Style) -> Style

Adds this element to the given parameter, returning it updated.

impl StylingElement<Style> for TargetedColor

fn add_to(self, composed_styling: Style) -> Style

Adds this element to the given parameter, returning it updated.

impl StylingElement<Style> for UnderlineEffect

fn add_to(self, composed_styling: Style) -> Style

Adds this element to the given parameter, returning it updated.

impl Copy for Style

impl Eq for Style

impl StructuralPartialEq for Style