Skip to main content

Style

Struct Style 

Source
pub struct Style {
    pub foreground: Option<Color>,
    pub background: Option<Color>,
    pub bold: bool,
    pub dim: bool,
    pub italic: bool,
    pub underline: bool,
    pub blink: bool,
    pub reverse: bool,
    pub hidden: bool,
    pub strikethrough: bool,
}
Expand description

Style attributes for text.

Fields§

§foreground: Option<Color>

Foreground color

§background: Option<Color>

Background color

§bold: bool

Bold text

§dim: bool

Dim/faint text

§italic: bool

Italic text

§underline: bool

Underlined text

§blink: bool

Blinking text

§reverse: bool

Reversed colors (fg/bg swapped)

§hidden: bool

Hidden/invisible text

§strikethrough: bool

Strikethrough text

Implementations§

Source§

impl Style

Source

pub const fn new() -> Self

Create a new empty style.

Source

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

Set the foreground color.

Source

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

Set the background color.

Source

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

Set the foreground color (alias for consistency with Rich).

Source

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

Set the background color (alias for consistency with Rich).

Source

pub fn bold(self) -> Self

Enable bold.

Source

pub fn dim(self) -> Self

Enable dim/faint.

Source

pub fn italic(self) -> Self

Enable italic.

Source

pub fn underline(self) -> Self

Enable underline.

Enable blink.

Source

pub fn reverse(self) -> Self

Enable reverse (swap fg/bg).

Source

pub fn hidden(self) -> Self

Enable hidden/invisible.

Source

pub fn strikethrough(self) -> Self

Enable strikethrough.

Source

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

Combine this style with another, with other taking precedence.

Source

pub fn is_empty(&self) -> bool

Check if this style has any attributes set.

Source

pub fn parse(s: &str) -> Self

Parse a style from a string.

Supports space-separated attributes: “bold red on blue”

Source

pub fn to_crossterm_attributes(&self) -> Attributes

Apply this style to crossterm for rendering.

Source

pub fn to_css(&self) -> String

Convert this style to CSS inline style string.

Returns a string suitable for use in HTML style attributes.

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

Source§

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

Formats the value using the given formatter. 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 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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.