Skip to main content

Style

Struct Style 

Source
pub struct Style {
    pub fg: Option<Color>,
    pub bg: Option<Color>,
    pub bold: bool,
    pub dim: bool,
    pub italic: bool,
    pub underline: bool,
    pub strikethrough: bool,
    pub blink: bool,
    pub reset: bool,
    pub prefix: Option<String>,
}
Expand description

A complete set of visual attributes for a span of text.

Fields§

§fg: Option<Color>

Foreground color. None leaves the terminal default unchanged.

§bg: Option<Color>

Background color. None leaves the terminal default unchanged.

§bold: bool

Bold text (SGR 1).

§dim: bool

Reduced intensity text (SGR 2).

§italic: bool

Italic text (SGR 3).

§underline: bool

Underlined text (SGR 4).

§strikethrough: bool

Crossed-out text (SGR 9).

§blink: bool

Blinking text (SGR 5). Terminal support varies.

§reset: bool

Full reset. Enabling this option overrides all previous options.

§prefix: Option<String>

Optional prefix string prepended before the style’s escape sequence.

Implementations§

Source§

impl Style

Source

pub fn parse(markup: impl Into<String>) -> Result<Self, LexError>

Parses a farben markup string into a Style.

Tokenizes markup and folds the resulting tags into a single Style value. Text tokens are ignored; only tag tokens affect the output.

§Errors

Returns a LexError if markup contains an unclosed tag, an unrecognized tag name, or an invalid color argument.

§Example
let style = Style::parse("[bold red]")?;
assert!(style.bold);
assert_eq!(style.fg, Some(Color::Named(NamedColor::Red)));

Trait Implementations§

Source§

impl Clone for Style

Source§

fn clone(&self) -> Style

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for Style

Source§

fn default() -> Style

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

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, 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.