Struct TextBuilder 

pub struct TextBuilder { /* private fields */ }

Build a styled paragraph run by run (docs/text-runs.md).

A builder exists because byte ranges are error-prone to write by hand and meaningless to read: TextRun { range: 12..19, .. } says nothing about which word it covers. Appending text and its style together keeps the two from drifting apart.

label("").runs_from(
    TextBuilder::new()
        .text("Saved to ")
        .code("~/Documents")
        .text(" just now — ")
        .strong("do not close")
        .text(" the window."),
)

Implementations

impl TextBuilder

pub fn new() -> Self

pub fn base(self, font: Font) -> Self

The style the emphasis variants build on. Set it to the label’s font so a bold run inside a Footnote paragraph stays footnote-sized.

pub fn text(self, s: &str) -> Self

Unstyled text: it draws with the label’s own font.

pub fn run(self, s: &str, run: impl FnOnce(Range<usize>) -> TextRun) -> Self

A run with a fully specified style.

pub fn strong(self, s: &str) -> Self

Bold.

pub fn emphasis(self, s: &str) -> Self

Italic.

pub fn code(self, s: &str) -> Self

Inline code: the platform’s monospaced face at this style’s size.

pub fn colored(self, s: &str, color: Color) -> Self

A colored phrase.

pub fn underline(self, s: &str) -> Self

Underlined.

pub fn highlight(self, s: &str, color: Color) -> Self

Highlighted: a color painted behind the glyphs, for a search hit or a review mark.

Sets the foreground too, through the same readable-on-a-fill rule Button::tint uses: a highlight is usually a pale wash, and the label’s own text color is chosen for the window’s background rather than for the swatch now sitting under it. On a dark theme that pairing puts light text on pale amber, which is the one combination a highlight must not produce. Use TextBuilder::run where an app wants to state both itself.

pub fn sized(self, s: &str, scale: f64) -> Self

A relative size: 1.5 is half again the base style’s, 0.8 smaller (FontSpec::scale). Relative rather than a point size so the phrase still tracks the reader’s accessibility text-size setting.

pub fn strikethrough(self, s: &str) -> Self

Struck through.

pub fn link(self, s: &str, target: &str) -> Self

A link run. A #route target navigates in-app, as with link. Rendering it is Cap::TextRuns; activating it is Cap::TextLinks, which fewer backends have, so check before relying on the tap (docs/text-runs.md).

pub fn build(self) -> (String, Vec<TextRun>)

The assembled text and its runs.

Trait Implementations

impl Clone for TextBuilder

fn clone(&self) -> TextBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextBuilder

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

Formats the value using the given formatter.

impl Default for TextBuilder

fn default() -> TextBuilder

Returns the “default value” for a type.