Struct TextStyle 

pub struct TextStyle { /* private fields */ }

A reusable set of text styling rules.

A TextStyle carries no geometry. A position that renders inline text cannot honor padding, a border, or a dimension, so those properties live on BlockStyle instead and the illegal combination is unrepresentable rather than merely discouraged.

A TextStyle is an immutable value: builder methods consume and return it, so styles can be stored, cloned, and extended without affecting each other.

use urushi::{Color, TextStyle};

let base = TextStyle::new().foreground(Color::CYAN);
let emphasized = base.clone().bold();

let text = urushi::StyledText::new("hello", emphasized);
let _ = text;

Geometry is not merely discouraged here, it is unrepresentable:

use urushi::{Border, TextStyle};

let _ = TextStyle::new().border(Border::ROUNDED);

Implementations

impl TextStyle

pub fn new() -> Self

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

Sets the text foreground color.

pub fn reset_foreground(self) -> Self

Returns the text foreground color to the terminal default.

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

Sets the text background color.

pub fn reset_background(self) -> Self

Returns the text background color to the terminal default.

pub fn add_attribute(self, attribute: TextAttribute) -> Self

Adds one active text attribute.

pub fn add_attributes(self, attributes: TextAttributes) -> Self

Adds a set of active text attributes.

pub fn remove_attribute(self, attribute: TextAttribute) -> Self

Removes one active text attribute.

pub fn remove_attributes(self, attributes: TextAttributes) -> Self

Removes a set of active text attributes.

pub fn reset_attributes(self) -> Self

Removes every active text attribute.

pub fn bold(self) -> Self

pub fn dim(self) -> Self

pub fn italic(self) -> Self

pub fn underlined(self) -> Self

Underlines the text with a single line in the foreground color.

This sets the complete default underline value; the other two builders below refine an underline that may already be set.

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

Sets the shape the underline is drawn with, adding an underline in the foreground color when the style has none.

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

Sets the color the underline is drawn in, adding a single underline when the style has none.

A color is only reachable through an underline, so a style cannot carry an underline color that nothing draws.

pub fn underline(self, underline: Underline) -> Self

Replaces the complete underline value.

pub fn reset_underline(self) -> Self

Removes the underline, including its color.

pub fn hyperlink(self, hyperlink: impl Into<Hyperlink>) -> Self

Attaches an OSC 8 hyperlink to this text.

A URI converts directly for the ordinary case. Use Hyperlink when the link needs parameters such as id.

pub fn reset_hyperlink(self) -> Self

Removes the OSC 8 hyperlink from this text.

pub fn blink(self) -> Self

pub fn reverse(self) -> Self

pub fn hide(self) -> Self

pub fn strikethrough(self) -> Self

pub const fn get_foreground(&self) -> Option<Color>

Returns the foreground color instruction, if this style sets one.

pub const fn get_background(&self) -> Option<Color>

Returns the background color instruction, if this style sets one.

pub const fn get_underline(&self) -> Option<Underline>

Returns the underline instruction, if this style sets one.

pub fn get_hyperlink(&self) -> Option<&Hyperlink>

Returns the hyperlink attached to this text, if any.

pub const fn get_attributes(&self) -> TextAttributes

Returns the active text attributes.

Trait Implementations

impl Clone for TextStyle

fn clone(&self) -> TextStyle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextStyle

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

Formats the value using the given formatter.

impl Default for TextStyle

fn default() -> TextStyle

Returns the “default value” for a type.

impl<'a> From<&'a TextStyle> for TerminalTextStyle<'a>

fn from(value: &'a TextStyle) -> Self

Converts to this type from the input type.

impl PartialEq for TextStyle

fn eq(&self, other: &TextStyle) -> 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 Eq for TextStyle

impl StructuralPartialEq for TextStyle