Struct TextRun 

pub struct TextRun {
    pub range: Range<usize>,
    pub font: FontSpec,
    pub color: Option<Color>,
    pub background: Option<Color>,
    pub underline: Underline,
    pub strikethrough: bool,
    pub link: Option<String>,
}

One styled span of a label’s text (docs/text-runs.md).

range is a byte range into the label’s text. Bytes, not chars: every backend that takes a structured attributed string wants UTF-16 or byte offsets, str slicing is byte-based, and a char count would have to be converted at every boundary. Ranges must be non-overlapping and ascending; a gap between them is unstyled text, drawn with the label’s own font.

A run says only what differs. font is the whole descriptor rather than a delta because a bold run inside a Body paragraph is FontSpec { style: Body, weight: Some(Bold), .. }. The style has to travel with the weight or the run loses its semantic size.

Fields

range: Range<usize>

font: FontSpec

color: Option<Color>

background: Option<Color>

A highlight painted behind the glyphs. Every native text editor carries this attribute (docs/texteditor.md), and search hits and review comments are the two things an app is asked for the moment it has styled text at all.

underline: Underline

A line under the text.

strikethrough: bool

A line through the text. Separate from FontSpec because it is a decoration, not a face: no platform expresses it by picking a different font.

link: Option<String>

Makes this run a link to the given target. Rendering it is Cap::TextRuns; making it activatable is Cap::TextLinks, which is a smaller set (see the docs).

Implementations

impl TextRun

pub fn font(range: Range<usize>, font: FontSpec) -> TextRun

A run that only changes the font, the common case for emphasis.

pub fn style(&self) -> RunStyle

This run’s attributes without its range: what a selection’s style is compared against and what an editor’s toolbar toggles (docs/texteditor.md).

pub fn styled(range: Range<usize>, style: RunStyle) -> TextRun

A run of style over range.

Trait Implementations

impl Clone for TextRun

fn clone(&self) -> TextRun

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextRun

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

Formats the value using the given formatter.

impl Default for TextRun

fn default() -> TextRun

Returns the “default value” for a type.

impl PartialEq for TextRun

fn eq(&self, other: &TextRun) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for TextRun