Struct StyledText 

pub struct StyledText<T> {
    pub text: T,
    pub fg: Option<Color>,
    pub bg: Option<Color>,
    pub style_mask: u8,
}

A deferred evaluation builder for ANSI terminal styles.

Instead of allocating strings immediately, StyledText stores the requested styles and injects the ANSI escape codes directly into the buffer when std::fmt::Display is invoked. This ensures maximum performance and prevents duplicate reset codes.

Fields

text: T

The underlying text or data to be styled.

fg: Option<Color>

The foreground color to be applied, if any.

bg: Option<Color>

The background color to be applied, if any.

style_mask: u8

A list of text formatting styles to be applied.

Implementations

impl<T> StyledText<T>

pub const fn new(text: T) -> Self

Creates a new StyledText instance wrapping the provided text.

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

Sets the foreground color to the specified Color.

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

Sets the background color to the specified Color.

pub const fn fixed(self, n: u8) -> Self

Sets the foreground color using an 8-bit (256-color) palette index.

pub const fn rgb(self, r: u8, g: u8, b: u8) -> Self

Sets the foreground color using an RGB TrueColor value.

pub const fn bg_fixed(self, n: u8) -> Self

Sets the background color using an 8-bit (256-color) palette index.

pub const fn bg_rgb(self, r: u8, g: u8, b: u8) -> Self

Sets the background color using an RGB TrueColor value.

pub const fn reset(self) -> Self

Clears all applied styles, foreground, and background colors.

pub const fn black(self) -> Self

Sets the foreground color to black.

pub const fn bright_black(self) -> Self

Sets the foreground color to bright black (gray).

pub const fn bright_red(self) -> Self

Sets the foreground color to bright red.

pub const fn bright_green(self) -> Self

Sets the foreground color to bright green.

pub const fn bright_yellow(self) -> Self

Sets the foreground color to bright yellow.

pub const fn bright_blue(self) -> Self

Sets the foreground color to bright blue.

pub const fn bright_magenta(self) -> Self

Sets the foreground color to bright magenta.

pub const fn bright_cyan(self) -> Self

Sets the foreground color to bright cyan.

pub const fn bright_white(self) -> Self

Sets the foreground color to bright white.

pub const fn red(self) -> Self

Sets the foreground color to red.

pub const fn green(self) -> Self

Sets the foreground color to green.

pub const fn yellow(self) -> Self

Sets the foreground color to yellow.

pub const fn blue(self) -> Self

Sets the foreground color to blue.

pub const fn magenta(self) -> Self

Sets the foreground color to magenta.

pub const fn cyan(self) -> Self

Sets the foreground color to cyan.

pub const fn white(self) -> Self

Sets the foreground color to white.

pub const fn bg_black(self) -> Self

Sets the background color to black.

pub const fn bg_bright_black(self) -> Self

Sets the background color to bright black (gray).

pub const fn bg_bright_red(self) -> Self

Sets the background color to bright red.

pub const fn bg_bright_green(self) -> Self

Sets the background color to bright green.

pub const fn bg_bright_yellow(self) -> Self

Sets the background color to bright yellow.

pub const fn bg_bright_blue(self) -> Self

Sets the background color to bright blue.

pub const fn bg_bright_magenta(self) -> Self

Sets the background color to bright magenta.

pub const fn bg_bright_cyan(self) -> Self

Sets the background color to bright cyan.

pub const fn bg_bright_white(self) -> Self

Sets the background color to bright white.

pub const fn bg_red(self) -> Self

Sets the background color to red.

pub const fn bg_green(self) -> Self

Sets the background color to green.

pub const fn bg_yellow(self) -> Self

Sets the background color to yellow.

pub const fn bg_blue(self) -> Self

Sets the background color to blue.

pub const fn bg_magenta(self) -> Self

Sets the background color to magenta.

pub const fn bg_cyan(self) -> Self

Sets the background color to cyan.

pub const fn bg_white(self) -> Self

Sets the background color to white.

pub const fn underline(self) -> Self

Adds the underline style to the text.

pub const fn dim(self) -> Self

Decreases the intensity of the text color.

pub const fn italic(self) -> Self

Adds the italic style to the text.

pub const fn blink(self) -> Self

Adds the blink style to the text.

pub const fn reverse(self) -> Self

Reverses the foreground and background colors.

pub const fn hidden(self) -> Self

Hides the text completely.

pub const fn strikethrough(self) -> Self

Adds a strikethrough line to the text.

pub const fn bold(self) -> Self

Adds the bold style to the text.

Examples found in repository

examples/demo.rs (line 22)

fn main() -> Result<(), Box<dyn std::error::Error>> {
  // 1. Terminal Initialization
  // Mandatory for enabling ANSI support on Windows.
  // On Linux/macOS, this is a no-op (native support).
  cirious_codex_term::init_term();

  // 2. Fluid Styling
  // The `StyleExt` trait allows chaining styles directly onto any type that
  // implements `Display`. This avoids unnecessary allocations and improves
  // code readability.
  println!("{}", "Hello, Codex Term!".cyan().bold());

  // 3. Cursor Manipulation
  // We use a handle to `stdout` to ensure escape sequences are written
  // directly to the system buffer.
  let mut handle = stdout();

  Cursor::down(&mut handle, 2)?;
  Cursor::right(&mut handle, 5)?;

  // 4. Explicitly write and flush to ensure the text appears at the
  // exact position before further operations.
  write!(handle, "I am here!")?;
  handle.flush()?;

  // 5. Cursor Visibility
  // Hiding the cursor is essential for TUI (Terminal User Interface)
  // applications to prevent flickering and visual clutter.
  Cursor::hide(&mut handle)?;
  println!("\nCursor hidden for 1 second...");
  std::thread::sleep(std::time::Duration::from_secs(1));

  Cursor::show(&mut handle)?;
  println!("Cursor restored.");

  Ok(())
}

Trait Implementations

impl<T: Debug> Debug for StyledText<T>

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

Formats the value using the given formatter.

impl<T: Display> Display for StyledText<T>

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

Formats the value using the given formatter.