Struct stylic::Style

pub struct Style {
    pub fg: Color,
    pub bg: Color,
    pub underline: Option<Color>,
    pub attributes: Attributes,
}

A style!

You don’t need to use this type directly, since Styled and StyledLink both have the same methods for styling.

However, it may be useful to store a style and apply it to a value later:

let my_style = Style::new().bold().blue();

println!("{}", style("Hello").apply(my_style));

Seee Stylize for more available styling options.

Style also implements Display so can be displayed directly. This will apply the style to all following text until a new style is applied, making it a less convenient way of styling text, but the option’s there.

Fields

fg: Color

Foreground color.

bg: Color

Background color.

underline: Option<Color>

Underline color.

This sets the color used for underlining when the underline attribute is enabled, but does not enable underlining by itself.

attributes: Attributes

Attributes such as bold, italic, etc.

Implementations

impl Style

pub const fn new() -> Self

Create a new style with no attributes and default colors.

Examples found in repository

examples/style.rs (line 4)

fn main() {
    let my_style = Style::new().bold().blue();

    println!("{}!", style("Hello").apply(my_style));

    println!(
        "{}",
        style("Rust Language")
            .apply(my_style)
            .link("https://rust-lang.org")
    );
}

Trait Implementations

impl Clone for Style

fn clone(&self) -> Style

Returns a copy 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 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 Ord for Style

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Stylize for Style

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

Set the foreground color.

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

Set the background color.

fn underline_colored(self, color: impl Into<Color>) -> Self

Set the underline attribute and color.

fn attributes(self, attrs: Attributes) -> Self

Set the attributes.

fn bold(self) -> Self

Set the bold attribute.

fn dim(self) -> Self

Set the dim attribute.

fn italic(self) -> Self

Set the italic attribute.

fn underline(self) -> Self

Set the underline attribute.

fn blink(self) -> Self

Set the blink attribute.

fn reverse(self) -> Self

Set the reverse attribute.

fn hidden(self) -> Self

Set the hidden attribute.

fn strikethrough(self) -> Self

Set the strikethrough attribute.

fn black(self) -> Self

Set the foreground color to black.

fn on_black(self) -> Self

Set the background color to black.

fn underline_black(self) -> Self

Set the underline attribute, and set the underline color to black.

fn red(self) -> Self

Set the foreground color to red.

fn on_red(self) -> Self

Set the background color to red.

fn underline_red(self) -> Self

Set the underline attribute, and set the underline color to red.

fn green(self) -> Self

Set the foreground color to green.

fn on_green(self) -> Self

Set the background color to green.

fn underline_green(self) -> Self

Set the underline attribute, and set the underline color to green.

fn yellow(self) -> Self

Set the foreground color to yellow.

fn on_yellow(self) -> Self

Set the background color to yellow.

fn underline_yellow(self) -> Self

Set the underline attribute, and set the underline color to yellow.

fn blue(self) -> Self

Set the foreground color to blue.

fn on_blue(self) -> Self

Set the background color to blue.

fn underline_blue(self) -> Self

Set the underline attribute, and set the underline color to blue.

fn magenta(self) -> Self

Set the foreground color to magenta.

fn on_magenta(self) -> Self

Set the background color to magenta.

fn underline_magenta(self) -> Self

Set the underline attribute, and set the underline color to magenta.

fn cyan(self) -> Self

Set the foreground color to cyan.

fn on_cyan(self) -> Self

Set the background color to cyan.

fn underline_cyan(self) -> Self

Set the underline attribute, and set the underline color to cyan.

fn white(self) -> Self

Set the foreground color to white.

fn on_white(self) -> Self

Set the background color to white.

fn underline_white(self) -> Self

Set the underline attribute, and set the underline color to white.

fn bright_black(self) -> Self

Set the foreground color to bright black.

fn on_bright_black(self) -> Self

Set the background color to bright black.

fn underline_bright_black(self) -> Self

Set the underline attribute, and set the underline color to bright black.

fn bright_red(self) -> Self

Set the foreground color to bright red.

fn on_bright_red(self) -> Self

Set the background color to bright red.

fn underline_bright_red(self) -> Self

Set the underline attribute, and set the underline color to bright red.

fn bright_green(self) -> Self

Set the foreground color to bright green.

fn on_bright_green(self) -> Self

Set the background color to bright green.

fn underline_bright_green(self) -> Self

Set the underline attribute, and set the underline color to bright green.

fn bright_yellow(self) -> Self

Set the foreground color to bright yellow.

fn on_bright_yellow(self) -> Self

Set the background color to bright yellow.

fn underline_bright_yellow(self) -> Self

Set the underline attribute, and set the underline color to bright yellow.

fn bright_blue(self) -> Self

Set the foreground color to bright blue.

fn on_bright_blue(self) -> Self

Set the background color to bright blue.

fn underline_bright_blue(self) -> Self

Set the underline attribute, and set the underline color to bright blue.

fn bright_magenta(self) -> Self

Set the foreground color to bright magenta.

fn on_bright_magenta(self) -> Self

Set the background color to bright magenta.

fn underline_bright_magenta(self) -> Self

Set the underline attribute, and set the underline color to bright magenta.

fn bright_cyan(self) -> Self

Set the foreground color to bright cyan.

fn on_bright_cyan(self) -> Self

Set the background color to bright cyan.

fn underline_bright_cyan(self) -> Self

Set the underline attribute, and set the underline color to bright cyan.

fn bright_white(self) -> Self

Set the foreground color to bright white.

fn on_bright_white(self) -> Self

Set the background color to bright white.

fn underline_bright_white(self) -> Self

Set the underline attribute, and set the underline color to bright white.

impl Copy for Style

impl Eq for Style

impl StructuralPartialEq for Style