Struct Style 

pub struct Style { /* private fields */ }

A terminal style.

Supports foreground color, background color, attributes, and an optional hyperlink. Attributes use a three-state system: set to true, set to false, or not set (None).

Implementations

impl Style

pub fn null() -> Self

Create a null (empty) style.

pub fn new() -> Self

Create a new style with optional settings.

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

Builder: set foreground color.

pub fn bgcolor(self, bgcolor: impl Into<Option<Color>>) -> Self

Builder: set background color.

pub fn bold(self, value: bool) -> Self

Builder: set bold.

pub fn dim(self, value: bool) -> Self

Builder: set dim.

pub fn italic(self, value: bool) -> Self

Builder: set italic.

pub fn underline(self, value: bool) -> Self

Builder: set underline.

pub fn blink(self, value: bool) -> Self

Builder: set blink.

pub fn reverse(self, value: bool) -> Self

Builder: set reverse.

pub fn strike(self, value: bool) -> Self

Builder: set strikethrough.

pub fn blink2(self, value: bool) -> Self

Builder: set blink2 (rapid blink).

pub fn conceal(self, value: bool) -> Self

Builder: set conceal.

pub fn underline2(self, value: bool) -> Self

Builder: set double underline.

pub fn frame(self, value: bool) -> Self

Builder: set frame.

pub fn encircle(self, value: bool) -> Self

Builder: set encircle.

pub fn overline(self, value: bool) -> Self

Builder: set overline.

pub fn without_color(&self) -> Self

Return a copy with foreground and background colors stripped.

pub fn background_style(&self) -> Self

Return a style with the background color set to the foreground color, useful for background-only rendering.

pub fn transparent_background(&self) -> bool

Returns true if the background is not set (transparent).

pub fn link(self, url: impl Into<String>) -> Self

Builder: set link.

pub fn from_str(definition: &str) -> Self

Builder: set style from a string (e.g. “bold red on blue”).

pub fn is_null(&self) -> bool

Returns true if this is a null (empty) style.

pub fn is_plain(&self) -> bool

Returns true if this style has no colors, attributes, or link set.

pub fn get_bold(&self) -> Option<bool>

Check if the bold attribute is explicitly set to true.

pub fn get_italic(&self) -> Option<bool>

Check if the italic attribute is explicitly set to true.

pub fn combine(&self, other: &Style) -> Style

Merge two styles: self is the base, other overrides.

pub fn to_ansi(&self) -> String

Render this style as ANSI SGR escape sequences.

pub fn reset_ansi(&self) -> &'static str

Return the ANSI reset sequence needed to turn off this style.

pub fn chain(&self, other: &Style) -> Style

Create a chain-of-styles fallback. When self has a value set, use it; otherwise fall through to other.

pub fn copy(&self) -> Style

Explicit clone (delegates to Clone, named for Python parity).

pub fn clear_meta_and_links(&mut self) -> &mut Self

Clear the meta field and link field, returning self for chaining.

pub fn from_color(color: Color) -> Self

Create a style with just a foreground color set.

pub fn from_meta(meta: Vec<u8>) -> Self

Create a style with metadata.

pub fn get_html_style(&self, _theme: Option<&ExportTheme>) -> String

Generate CSS style string for HTML export.

pub fn normalize(&self) -> Style

Return a “normalized” style: remove negative (explicitly false) attributes that just reset inherited ones. Only keep explicitly true attributes and colors.

pub fn pick_first(&self) -> Option<&'static str>

Return the “first” significant color name for display purposes (fg color name, or bg color name, or None).

pub fn render(&self, text: &str) -> String

Render text wrapped in this style’s ANSI codes.

pub fn test(&self, text: Option<&str>) -> String

Render a test/demo string. If text is None, use “Lorem ipsum”.

pub fn update_link(&mut self, url: Option<String>) -> &mut Self

Update or clear the link, returning self for chaining.

pub fn meta(&self) -> Option<&Vec<u8>>

Get a reference to metadata.

pub fn meta_mut(&mut self) -> Option<&mut Vec<u8>>

Get a mutable reference to metadata.

pub fn set_meta(&mut self, meta: Option<Vec<u8>>) -> &mut Self

Set metadata, returning self for chaining.

pub fn link_id(&self) -> u32

Get the link ID.

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

Alias for bgcolor() (Python rich has both .on() and .bgcolor()).

pub fn color_ref(&self) -> Option<&Color>

Get a reference to the foreground color.

pub fn bgcolor_ref(&self) -> Option<&Color>

Get a reference to the background color.

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() -> Self

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

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

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