Skip to main content

Style

Struct Style 

Source
pub struct Style {
    pub fg: Option<Color>,
    pub bg: Option<Color>,
    pub modifiers: Modifiers,
    pub underline_color: Option<Color>,
    pub underline_style: UnderlineStyle,
}
Expand description

Visual style for a terminal cell (foreground, background, modifiers).

Styles are applied to text via the builder methods on Context widget calls (e.g., .bold(), .fg(Color::Cyan)). All fields are optional; None means “inherit from the terminal default.”

§Example

use slt::{Style, Color};

let style = Style::new().fg(Color::Cyan).bold();

Fields§

§fg: Option<Color>

Foreground color, or None to use the terminal default.

§bg: Option<Color>

Background color, or None to use the terminal default.

§modifiers: Modifiers

Text modifiers (bold, italic, underline, etc.).

§underline_color: Option<Color>

Underline color, or None to use the same color as the foreground.

Emitted as SGR 58 when set and SGR 59 (reset to foreground) when cleared. Requires a terminal that supports separate underline colors.

§underline_style: UnderlineStyle

Underline rendering style (straight, curly, dotted, etc.).

Defaults to UnderlineStyle::Straight. Non-straight styles are emitted as CSI 4:Nm and require terminal support.

Implementations§

Source§

impl Style

Source

pub const fn new() -> Self

Create a new style with no color or modifiers set.

Source

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

Set the foreground color.

Source

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

Set the background color.

Source

pub fn bold(self) -> Self

Add the bold modifier.

Source

pub fn dim(self) -> Self

Add the dim modifier.

Source

pub fn italic(self) -> Self

Add the italic modifier.

Source

pub fn underline(self) -> Self

Add the underline modifier.

Source

pub fn reversed(self) -> Self

Add the reversed (inverted colors) modifier.

Source

pub fn strikethrough(self) -> Self

Add the strikethrough modifier.

Add the slow-blink modifier (SGR 5).

Source

pub fn overline(self) -> Self

Add the overline modifier (SGR 53).

Source

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

Set a separate underline color.

Setting this implies the Modifiers::UNDERLINE bit so the underline is actually rendered. Emitted as SGR 58.

§Example
use slt::{Color, Modifiers, Style};

let s = Style::new().underline_color(Color::Red);
assert!(s.modifiers.contains(Modifiers::UNDERLINE));
Source

pub const fn underline_style(self, style: UnderlineStyle) -> Self

Set the underline rendering style (straight, curly, dotted, etc.).

Setting a style implies the Modifiers::UNDERLINE bit so the underline is actually rendered. Emitted as CSI 4:Nm.

§Example
use slt::{Modifiers, Style, UnderlineStyle};

let s = Style::new().underline_style(UnderlineStyle::Curly);
assert!(s.modifiers.contains(Modifiers::UNDERLINE));

Trait Implementations§

Source§

impl Clone for Style

Source§

fn clone(&self) -> Style

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Style

Source§

impl Debug for Style

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Style

Source§

fn default() -> Style

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Style

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for Style

Source§

impl Hash for Style

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Style

Source§

fn eq(&self, other: &Style) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Style

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Style

Auto Trait Implementations§

§

impl Freeze for Style

§

impl RefUnwindSafe for Style

§

impl Send for Style

§

impl Sync for Style

§

impl Unpin for Style

§

impl UnsafeUnpin for Style

§

impl UnwindSafe for Style

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.