Struct Style

#[non_exhaustive]
pub struct Style {
    pub foreground: Color,
    pub background: Color,
    pub intensity: Intensity,
}

A style to render text with, setting the foreground and background colors, along with intensity.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

foreground: Color

The text foreground color

background: Color

The text background color

intensity: Intensity

The text intensity

Implementations

impl Style

pub fn with(self, adj: impl Restyle) -> Style

Apply a modification to this style, returning the result.

use stylish::{Intensity, Style};

let mut expected = Style::default();
expected.intensity = Intensity::Faint;

assert_eq!(Style::default().with(Intensity::Faint), expected);

pub fn diff_from(self, original: Style) -> StyleDiff

Find the changes from the original style that would result in this style.

This can be useful for writers like ansi that are stateful, finding the minimal state that must be changed between the current output style and the new style.

use stylish::{Color, Foreground, Style, StyleDiff};

let original = Style::default();
let updated = original.with(Foreground(Color::Cyan));

assert!(matches!(
    updated.diff_from(original),
    StyleDiff {
        foreground: Some(Color::Cyan),
        background: None,
        intensity: None,
        ..
    }
));

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<(), Error>

Formats the value using the given formatter.

impl Default for Style

fn default() -> Style

Returns the “default value” for a type.

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 Restyle for Style

fn apply(&self, _style: Style) -> Style

Apply the restyling this instance represents to an existing style, returning the updated style.

impl Copy for Style

impl Eq for Style

impl StructuralPartialEq for Style