Struct Styled 

pub struct Styled {
    pub text: String,
    pub style: TextStyle,
}

Styled text — text content with one or more applied styles.

Examples

use scriba::{TextStyle, Styled};

let styled = Styled::new("Important", TextStyle::Bold);
assert_eq!(styled.text, "Important");
assert_eq!(styled.style, TextStyle::Bold);

Fields

text: String

The text content.

style: TextStyle

The applied style.

Implementations

impl Styled

pub fn new(text: impl Into<String>, style: TextStyle) -> Self

Create new styled text.

Examples found in repository

examples/styling.rs (line 21)

fn main() -> scriba::Result<()> {
    // Text format — ANSI escape codes applied
    println!("=== TEXT FORMAT (ANSI codes) ===\n");

    let ui_text = Ui::new().with_format(Format::Text);

    let output_text = Output::new()
        .heading(1, "Text Styling Examples")
        .styled_paragraph(Styled::new("This is bold text", TextStyle::Bold))
        .styled_paragraph(Styled::new("This is italic text", TextStyle::Italic))
        .styled_paragraph(Styled::new("This is bold and italic", TextStyle::BoldItalic))
        .styled_paragraph(Styled::new("This is underlined", TextStyle::Underline))
        .styled_paragraph(Styled::new("This is strikethrough", TextStyle::Strikethrough))
        .styled_paragraph(Styled::new("This is dimmed/faded", TextStyle::Dim));

    ui_text.print(&output_text)?;

    // Markdown format — Markdown syntax applied
    println!("\n=== MARKDOWN FORMAT ===\n");

    let ui_md = Ui::new().with_format(Format::Markdown);

    let output_md = Output::new()
        .heading(1, "Text Styling in Markdown")
        .styled_paragraph(Styled::new("This is bold", TextStyle::Bold))
        .styled_paragraph(Styled::new("This is italic", TextStyle::Italic))
        .styled_paragraph(Styled::new("This is bold italic", TextStyle::BoldItalic))
        .styled_paragraph(Styled::new("This has strikethrough", TextStyle::Strikethrough))
        .styled_paragraph(Styled::new("This is underlined", TextStyle::Underline));

    ui_md.print(&output_md)?;

    // Direct use of Styled API
    println!("\n=== DIRECT API ===\n");

    let bold_styled = Styled::new("Warning: check your config", TextStyle::Bold);
    let italic_styled = Styled::new("Optional: skip if unneeded", TextStyle::Italic);
    let dim_styled = Styled::new("Hint: use --verbose for more detail", TextStyle::Dim);

    println!("ANSI:");
    println!("  {}", bold_styled.render_ansi());
    println!("  {}", italic_styled.render_ansi());
    println!("  {}", dim_styled.render_ansi());

    println!("\nMarkdown:");
    println!("  {}", bold_styled.render_markdown());
    println!("  {}", italic_styled.render_markdown());
    println!("  {}", dim_styled.render_markdown());

    Ok(())
}

pub fn render_ansi(&self) -> String

Render styled text with ANSI codes (for Text format).

Examples found in repository

examples/styling.rs (line 53)

fn main() -> scriba::Result<()> {
    // Text format — ANSI escape codes applied
    println!("=== TEXT FORMAT (ANSI codes) ===\n");

    let ui_text = Ui::new().with_format(Format::Text);

    let output_text = Output::new()
        .heading(1, "Text Styling Examples")
        .styled_paragraph(Styled::new("This is bold text", TextStyle::Bold))
        .styled_paragraph(Styled::new("This is italic text", TextStyle::Italic))
        .styled_paragraph(Styled::new("This is bold and italic", TextStyle::BoldItalic))
        .styled_paragraph(Styled::new("This is underlined", TextStyle::Underline))
        .styled_paragraph(Styled::new("This is strikethrough", TextStyle::Strikethrough))
        .styled_paragraph(Styled::new("This is dimmed/faded", TextStyle::Dim));

    ui_text.print(&output_text)?;

    // Markdown format — Markdown syntax applied
    println!("\n=== MARKDOWN FORMAT ===\n");

    let ui_md = Ui::new().with_format(Format::Markdown);

    let output_md = Output::new()
        .heading(1, "Text Styling in Markdown")
        .styled_paragraph(Styled::new("This is bold", TextStyle::Bold))
        .styled_paragraph(Styled::new("This is italic", TextStyle::Italic))
        .styled_paragraph(Styled::new("This is bold italic", TextStyle::BoldItalic))
        .styled_paragraph(Styled::new("This has strikethrough", TextStyle::Strikethrough))
        .styled_paragraph(Styled::new("This is underlined", TextStyle::Underline));

    ui_md.print(&output_md)?;

    // Direct use of Styled API
    println!("\n=== DIRECT API ===\n");

    let bold_styled = Styled::new("Warning: check your config", TextStyle::Bold);
    let italic_styled = Styled::new("Optional: skip if unneeded", TextStyle::Italic);
    let dim_styled = Styled::new("Hint: use --verbose for more detail", TextStyle::Dim);

    println!("ANSI:");
    println!("  {}", bold_styled.render_ansi());
    println!("  {}", italic_styled.render_ansi());
    println!("  {}", dim_styled.render_ansi());

    println!("\nMarkdown:");
    println!("  {}", bold_styled.render_markdown());
    println!("  {}", italic_styled.render_markdown());
    println!("  {}", dim_styled.render_markdown());

    Ok(())
}

pub fn render_markdown(&self) -> String

Render styled text with Markdown syntax.

Examples found in repository

examples/styling.rs (line 58)

fn main() -> scriba::Result<()> {
    // Text format — ANSI escape codes applied
    println!("=== TEXT FORMAT (ANSI codes) ===\n");

    let ui_text = Ui::new().with_format(Format::Text);

    let output_text = Output::new()
        .heading(1, "Text Styling Examples")
        .styled_paragraph(Styled::new("This is bold text", TextStyle::Bold))
        .styled_paragraph(Styled::new("This is italic text", TextStyle::Italic))
        .styled_paragraph(Styled::new("This is bold and italic", TextStyle::BoldItalic))
        .styled_paragraph(Styled::new("This is underlined", TextStyle::Underline))
        .styled_paragraph(Styled::new("This is strikethrough", TextStyle::Strikethrough))
        .styled_paragraph(Styled::new("This is dimmed/faded", TextStyle::Dim));

    ui_text.print(&output_text)?;

    // Markdown format — Markdown syntax applied
    println!("\n=== MARKDOWN FORMAT ===\n");

    let ui_md = Ui::new().with_format(Format::Markdown);

    let output_md = Output::new()
        .heading(1, "Text Styling in Markdown")
        .styled_paragraph(Styled::new("This is bold", TextStyle::Bold))
        .styled_paragraph(Styled::new("This is italic", TextStyle::Italic))
        .styled_paragraph(Styled::new("This is bold italic", TextStyle::BoldItalic))
        .styled_paragraph(Styled::new("This has strikethrough", TextStyle::Strikethrough))
        .styled_paragraph(Styled::new("This is underlined", TextStyle::Underline));

    ui_md.print(&output_md)?;

    // Direct use of Styled API
    println!("\n=== DIRECT API ===\n");

    let bold_styled = Styled::new("Warning: check your config", TextStyle::Bold);
    let italic_styled = Styled::new("Optional: skip if unneeded", TextStyle::Italic);
    let dim_styled = Styled::new("Hint: use --verbose for more detail", TextStyle::Dim);

    println!("ANSI:");
    println!("  {}", bold_styled.render_ansi());
    println!("  {}", italic_styled.render_ansi());
    println!("  {}", dim_styled.render_ansi());

    println!("\nMarkdown:");
    println!("  {}", bold_styled.render_markdown());
    println!("  {}", italic_styled.render_markdown());
    println!("  {}", dim_styled.render_markdown());

    Ok(())
}

Trait Implementations

impl Clone for Styled

fn clone(&self) -> Styled

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Styled

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Styled

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Styled

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Styled

impl StructuralPartialEq for Styled