Struct Styled 

pub struct Styled<T, Link = WithoutLink> {
    pub value: T,
    pub style: Style,
    /* private fields */
}

A styled value.

Has builder methods for building a style. See crate level docs for examples of these.

Supports hyperlinks via the link method.

This type can be created using Styleable::styled or Styleable::styled_with.

Fields

value: T

style: Style

Implementations

impl<T, Link> Styled<T, Link>

pub const fn fg(self, color: Color) -> Self

Set the foreground color.

Examples found in repository

examples/pallete.rs (line 5)

fn main() {
    for i in 0..=255 {
        println!("{}", i.styled().fg(i.into()));
    }
}

pub const fn bg(self, color: Color) -> Self

Set the background color.

pub const fn underline_colored(self, color: Color) -> Self

Set the underline attribute and color.

Examples found in repository

examples/demo.rs (line 25)

fn main() {
    let hello = "Hello".styled().bold().red().on_blue();

    println!("{}", lazy_format!("{:b}", 12));

    let world = lazy_format!("Wor{}ld", lazy_format!("he{}he", "haha").styled().blue())
        .styled()
        .cyan()
        .inverted();

    println!("{hello}, {world}!");

    println!("{:?}", world.style);
    println!("{:?}", world.to_string());

    println!("{}", "strikethrough".styled().strikethrough());

    println!(
        "{}",
        "Google".styled().bold().green().link("https://google.com")
    );

    println!("{}", "Hello".styled().underline_colored(48.into()));
}

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

Set the attributes.

This will not unset any existing attributes.

pub const fn bold(self) -> Self

Set the bold attribute.

Examples found in repository

examples/demo.rs (line 4)

fn main() {
    let hello = "Hello".styled().bold().red().on_blue();

    println!("{}", lazy_format!("{:b}", 12));

    let world = lazy_format!("Wor{}ld", lazy_format!("he{}he", "haha").styled().blue())
        .styled()
        .cyan()
        .inverted();

    println!("{hello}, {world}!");

    println!("{:?}", world.style);
    println!("{:?}", world.to_string());

    println!("{}", "strikethrough".styled().strikethrough());

    println!(
        "{}",
        "Google".styled().bold().green().link("https://google.com")
    );

    println!("{}", "Hello".styled().underline_colored(48.into()));
}

pub const fn dim(self) -> Self

Set the dim attribute.

pub const fn italic(self) -> Self

Set the italic attribute.

pub const fn underlined(self) -> Self

Set the underline attribute.

pub const fn blink(self) -> Self

Set the blink attribute.

pub const fn inverted(self) -> Self

Set the inverted attribute.

Examples found in repository

examples/demo.rs (line 11)

fn main() {
    let hello = "Hello".styled().bold().red().on_blue();

    println!("{}", lazy_format!("{:b}", 12));

    let world = lazy_format!("Wor{}ld", lazy_format!("he{}he", "haha").styled().blue())
        .styled()
        .cyan()
        .inverted();

    println!("{hello}, {world}!");

    println!("{:?}", world.style);
    println!("{:?}", world.to_string());

    println!("{}", "strikethrough".styled().strikethrough());

    println!(
        "{}",
        "Google".styled().bold().green().link("https://google.com")
    );

    println!("{}", "Hello".styled().underline_colored(48.into()));
}

pub const fn hidden(self) -> Self

Set the hidden attribute.

pub const fn strikethrough(self) -> Self

Set the strikethrough attribute.

Examples found in repository

examples/demo.rs (line 18)

fn main() {
    let hello = "Hello".styled().bold().red().on_blue();

    println!("{}", lazy_format!("{:b}", 12));

    let world = lazy_format!("Wor{}ld", lazy_format!("he{}he", "haha").styled().blue())
        .styled()
        .cyan()
        .inverted();

    println!("{hello}, {world}!");

    println!("{:?}", world.style);
    println!("{:?}", world.to_string());

    println!("{}", "strikethrough".styled().strikethrough());

    println!(
        "{}",
        "Google".styled().bold().green().link("https://google.com")
    );

    println!("{}", "Hello".styled().underline_colored(48.into()));
}

pub const fn black(self) -> Self

Set the foreground color to black.

pub const fn on_black(self) -> Self

Set the background color to black.

pub const fn underline_black(self) -> Self

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

pub const fn red(self) -> Self

Set the foreground color to red.

Examples found in repository

examples/demo.rs (line 4)

fn main() {
    let hello = "Hello".styled().bold().red().on_blue();

    println!("{}", lazy_format!("{:b}", 12));

    let world = lazy_format!("Wor{}ld", lazy_format!("he{}he", "haha").styled().blue())
        .styled()
        .cyan()
        .inverted();

    println!("{hello}, {world}!");

    println!("{:?}", world.style);
    println!("{:?}", world.to_string());

    println!("{}", "strikethrough".styled().strikethrough());

    println!(
        "{}",
        "Google".styled().bold().green().link("https://google.com")
    );

    println!("{}", "Hello".styled().underline_colored(48.into()));
}

pub const fn on_red(self) -> Self

Set the background color to red.

pub const fn underline_red(self) -> Self

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

pub const fn green(self) -> Self

Set the foreground color to green.

Examples found in repository

examples/demo.rs (line 22)

fn main() {
    let hello = "Hello".styled().bold().red().on_blue();

    println!("{}", lazy_format!("{:b}", 12));

    let world = lazy_format!("Wor{}ld", lazy_format!("he{}he", "haha").styled().blue())
        .styled()
        .cyan()
        .inverted();

    println!("{hello}, {world}!");

    println!("{:?}", world.style);
    println!("{:?}", world.to_string());

    println!("{}", "strikethrough".styled().strikethrough());

    println!(
        "{}",
        "Google".styled().bold().green().link("https://google.com")
    );

    println!("{}", "Hello".styled().underline_colored(48.into()));
}

pub const fn on_green(self) -> Self

Set the background color to green.

pub const fn underline_green(self) -> Self

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

pub const fn yellow(self) -> Self

Set the foreground color to yellow.

pub const fn on_yellow(self) -> Self

Set the background color to yellow.

pub const fn underline_yellow(self) -> Self

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

pub const fn blue(self) -> Self

Set the foreground color to blue.

Examples found in repository

examples/demo.rs (line 8)

fn main() {
    let hello = "Hello".styled().bold().red().on_blue();

    println!("{}", lazy_format!("{:b}", 12));

    let world = lazy_format!("Wor{}ld", lazy_format!("he{}he", "haha").styled().blue())
        .styled()
        .cyan()
        .inverted();

    println!("{hello}, {world}!");

    println!("{:?}", world.style);
    println!("{:?}", world.to_string());

    println!("{}", "strikethrough".styled().strikethrough());

    println!(
        "{}",
        "Google".styled().bold().green().link("https://google.com")
    );

    println!("{}", "Hello".styled().underline_colored(48.into()));
}

pub const fn on_blue(self) -> Self

Set the background color to blue.

Examples found in repository

examples/demo.rs (line 4)

fn main() {
    let hello = "Hello".styled().bold().red().on_blue();

    println!("{}", lazy_format!("{:b}", 12));

    let world = lazy_format!("Wor{}ld", lazy_format!("he{}he", "haha").styled().blue())
        .styled()
        .cyan()
        .inverted();

    println!("{hello}, {world}!");

    println!("{:?}", world.style);
    println!("{:?}", world.to_string());

    println!("{}", "strikethrough".styled().strikethrough());

    println!(
        "{}",
        "Google".styled().bold().green().link("https://google.com")
    );

    println!("{}", "Hello".styled().underline_colored(48.into()));
}

pub const fn underline_blue(self) -> Self

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

pub const fn magenta(self) -> Self

Set the foreground color to magenta.

pub const fn on_magenta(self) -> Self

Set the background color to magenta.

pub const fn underline_magenta(self) -> Self

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

pub const fn cyan(self) -> Self

Set the foreground color to cyan.

Examples found in repository

examples/demo.rs (line 10)

fn main() {
    let hello = "Hello".styled().bold().red().on_blue();

    println!("{}", lazy_format!("{:b}", 12));

    let world = lazy_format!("Wor{}ld", lazy_format!("he{}he", "haha").styled().blue())
        .styled()
        .cyan()
        .inverted();

    println!("{hello}, {world}!");

    println!("{:?}", world.style);
    println!("{:?}", world.to_string());

    println!("{}", "strikethrough".styled().strikethrough());

    println!(
        "{}",
        "Google".styled().bold().green().link("https://google.com")
    );

    println!("{}", "Hello".styled().underline_colored(48.into()));
}

pub const fn on_cyan(self) -> Self

Set the background color to cyan.

pub const fn underline_cyan(self) -> Self

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

pub const fn white(self) -> Self

Set the foreground color to white.

pub const fn on_white(self) -> Self

Set the background color to white.

pub const fn underline_white(self) -> Self

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

pub const fn bright_black(self) -> Self

Set the foreground color to bright black.

pub const fn on_bright_black(self) -> Self

Set the background color to bright black.

pub const fn underline_bright_black(self) -> Self

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

pub const fn bright_red(self) -> Self

Set the foreground color to bright red.

pub const fn on_bright_red(self) -> Self

Set the background color to bright red.

pub const fn underline_bright_red(self) -> Self

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

pub const fn bright_green(self) -> Self

Set the foreground color to bright green.

pub const fn on_bright_green(self) -> Self

Set the background color to bright green.

pub const fn underline_bright_green(self) -> Self

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

pub const fn bright_yellow(self) -> Self

Set the foreground color to bright yellow.

pub const fn on_bright_yellow(self) -> Self

Set the background color to bright yellow.

pub const fn underline_bright_yellow(self) -> Self

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

pub const fn bright_blue(self) -> Self

Set the foreground color to bright blue.

pub const fn on_bright_blue(self) -> Self

Set the background color to bright blue.

pub const fn underline_bright_blue(self) -> Self

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

pub const fn bright_magenta(self) -> Self

Set the foreground color to bright magenta.

pub const fn on_bright_magenta(self) -> Self

Set the background color to bright magenta.

pub const fn underline_bright_magenta(self) -> Self

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

pub const fn bright_cyan(self) -> Self

Set the foreground color to bright cyan.

pub const fn on_bright_cyan(self) -> Self

Set the background color to bright cyan.

pub const fn underline_bright_cyan(self) -> Self

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

pub const fn bright_white(self) -> Self

Set the foreground color to bright white.

pub const fn on_bright_white(self) -> Self

Set the background color to bright white.

pub const fn underline_bright_white(self) -> Self

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

pub fn link<Uri>(self, uri: Uri) -> Styled<T, WithLink<Uri>>

where Uri: Display,

Set a link associated with this value.

This will create a clickable link in terminal emulators that support it.

Note that this method produces a different type to a styled value without a link - Styled<T, WithLink<Uri> as opposed to the default Styled<T, Link = WithoutLink>.

Examples

use stylic::Styleable;

println!("{}", "Click me!".styled().link("https://example.com"));

Examples found in repository

examples/style.rs (line 12)

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

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

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

examples/demo.rs (line 22)

fn main() {
    let hello = "Hello".styled().bold().red().on_blue();

    println!("{}", lazy_format!("{:b}", 12));

    let world = lazy_format!("Wor{}ld", lazy_format!("he{}he", "haha").styled().blue())
        .styled()
        .cyan()
        .inverted();

    println!("{hello}, {world}!");

    println!("{:?}", world.style);
    println!("{:?}", world.to_string());

    println!("{}", "strikethrough".styled().strikethrough());

    println!(
        "{}",
        "Google".styled().bold().green().link("https://google.com")
    );

    println!("{}", "Hello".styled().underline_colored(48.into()));
}

impl<T> Styled<T, WithoutLink>

pub const fn new(value: T, style: Style) -> Self

Create a new styled value.

This is not the recommended way of doing this (see Styleable::styled for a more convenient way), but could be useful in a const environment.

impl<T, Uri> Styled<T, WithLink<Uri>>

pub fn get_link(&self) -> &Uri

Access the link associated with this styled value.

Examples

use stylic::Styleable;

let my_linked_value = "Example link"
    .styled()
    .link("https://example.com");

println!("Link: {}", my_linked_value.get_link());

Trait Implementations

impl<T: Binary> Binary for Styled<T, WithoutLink>

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

Formats the value using the given formatter.

impl<T: Binary, Uri: Display> Binary for Styled<T, WithLink<Uri>>

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

Formats the value using the given formatter.

impl<T: Clone, Link: Clone> Clone for Styled<T, Link>

fn clone(&self) -> Styled<T, Link>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Default, Link: Default> Default for Styled<T, Link>

fn default() -> Styled<T, Link>

Returns the “default value” for a type.

impl<T: Display> Display for Styled<T, WithoutLink>

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

Formats the value using the given formatter.

impl<T: Display, Uri: Display> Display for Styled<T, WithLink<Uri>>

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

Formats the value using the given formatter.

impl<T: Hash, Link: Hash> Hash for Styled<T, Link>

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<T: LowerExp> LowerExp for Styled<T, WithoutLink>

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

Formats the value using the given formatter.

impl<T: LowerExp, Uri: Display> LowerExp for Styled<T, WithLink<Uri>>

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

Formats the value using the given formatter.

impl<T: LowerHex> LowerHex for Styled<T, WithoutLink>

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

Formats the value using the given formatter.

impl<T: LowerHex, Uri: Display> LowerHex for Styled<T, WithLink<Uri>>

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

Formats the value using the given formatter.

impl<T: Octal> Octal for Styled<T, WithoutLink>

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

Formats the value using the given formatter.

impl<T: Octal, Uri: Display> Octal for Styled<T, WithLink<Uri>>

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

Formats the value using the given formatter.

impl<T: Ord, Link: Ord> Ord for Styled<T, Link>

fn cmp(&self, other: &Styled<T, Link>) -> 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,

Restrict a value to a certain interval.

impl<T: PartialEq, Link: PartialEq> PartialEq for Styled<T, Link>

fn eq(&self, other: &Styled<T, Link>) -> 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<T: PartialOrd, Link: PartialOrd> PartialOrd for Styled<T, Link>

fn partial_cmp(&self, other: &Styled<T, Link>) -> 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<T: Pointer> Pointer for Styled<T, WithoutLink>

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

Formats the value using the given formatter.

impl<T: Pointer, Uri: Display> Pointer for Styled<T, WithLink<Uri>>

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

Formats the value using the given formatter.

impl<T: UpperExp> UpperExp for Styled<T, WithoutLink>

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

Formats the value using the given formatter.

impl<T: UpperExp, Uri: Display> UpperExp for Styled<T, WithLink<Uri>>

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

Formats the value using the given formatter.

impl<T: UpperHex> UpperHex for Styled<T, WithoutLink>

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

Formats the value using the given formatter.

impl<T: UpperHex, Uri: Display> UpperHex for Styled<T, WithLink<Uri>>

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

Formats the value using the given formatter.

impl<T: Copy, Link: Copy> Copy for Styled<T, Link>

impl<T: Eq, Link: Eq> Eq for Styled<T, Link>

impl<T, Link> StructuralPartialEq for Styled<T, Link>