Struct Style 

pub struct Style { /* private fields */ }

A style consisting of foreground and background color.

Examples

use retroglyph_core::color::{Color, Style};

let style = Style::new().fg(Color::GREEN).bg(Color::BLACK);
assert_eq!(style.foreground(), Color::GREEN);
assert_eq!(style.background(), Color::BLACK);

Implementations

impl Style

pub fn new() -> Style

Creates a new style with default values.

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

Sets the foreground color, which colors the cell’s glyph.

Does not tint a sprite: on a pixel backend, a cell whose glyph resolves to a sprite is composited from the sprite’s own pixels and ignores this color entirely. The same cell drawn by a cell backend falls back to its glyph and is colored by it, so one value can read very differently across backends. See Surface::put_span.

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

Sets the background color.

pub const fn foreground(&self) -> Color

Returns the foreground color.

pub const fn background(&self) -> Color

Returns the background color.

pub fn patch(self, other: Style) -> Style

Overlays another style onto this one, only if fields in other are non-default.

Color::Default in other means “unset”, not “reset to default”: a field left at Color::Default is skipped, and self’s existing value for that field is kept. This mirrors ratatui’s Style::patch convention, so Style::new().fg(Color::Default) is a no-op when patched onto anything, and there is no way to use patch to explicitly clear a field back to Color::Default; use Style::reset_fg or Style::reset_bg for that.

use retroglyph_core::color::{Color, Style};

let base = Style::new().fg(Color::RED).bg(Color::BLUE);

// Patching with a default `fg` leaves `base`'s red foreground untouched.
let patched = base.patch(Style::new().bg(Color::GREEN));
assert_eq!(patched.foreground(), Color::RED);
assert_eq!(patched.background(), Color::GREEN);

pub const fn reset_fg(self) -> Style

Resets the foreground color to Color::Default.

Unlike Style::patch, which treats Color::Default as “leave unset”, this explicitly clears the field. Use this when a caller needs to undo a previously patched-in foreground color rather than merge in a new one.

pub const fn reset_bg(self) -> Style

Resets the background color to Color::Default.

Unlike Style::patch, which treats Color::Default as “leave unset”, this explicitly clears the field. Use this when a caller needs to undo a previously patched-in background color rather than merge in a new one.

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

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<'de> Deserialize<'de> for Style

fn deserialize<__D>( __deserializer: __D, ) -> Result<Style, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Style

impl Hash for Style

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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: &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 Serialize for Style

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Style