Struct layout_2013::text_run::TextRun

pub struct TextRun {
    pub text: Arc<String>,
    pub pt_size: Au,
    pub font_metrics: FontMetrics,
    pub font_key: FontInstanceKey,
    pub glyphs: Arc<Vec<GlyphRun>>,
    pub bidi_level: Level,
    pub extra_word_spacing: Au,
}

A single “paragraph” of text in one font size and style.

Fields

text: Arc<String>

The UTF-8 string represented by this text run.

pt_size: Au

font_metrics: FontMetrics

font_key: FontInstanceKey

glyphs: Arc<Vec<GlyphRun>>

The glyph runs that make up this text run.

bidi_level: Level

extra_word_spacing: Au

Implementations

impl<'a> TextRun

pub fn new( font: FontRef, font_key: FontInstanceKey, text: String, options: &ShapingOptions, bidi_level: Level, breaker: &mut Option<LineBreakLeafIter>, ) -> (TextRun, bool)

Constructs a new text run. Also returns if there is a line break at the beginning

pub fn break_and_shape( font: FontRef, text: &str, options: &ShapingOptions, breaker: &mut Option<LineBreakLeafIter>, ) -> (Vec<GlyphRun>, bool)

pub fn ascent(&self) -> Au

pub fn advance_for_range(&self, range: &Range<ByteIndex>) -> Au

pub fn metrics_for_range(&self, range: &Range<ByteIndex>) -> RunMetrics

pub fn metrics_for_slice( &self, glyphs: &GlyphStore, slice_range: &Range<ByteIndex>, ) -> RunMetrics

pub fn min_width_for_range(&self, range: &Range<ByteIndex>) -> Au

pub fn minimum_splittable_inline_size(&self, range: &Range<ByteIndex>) -> Au

fn index_of_first_glyph_run_containing(&self, index: ByteIndex) -> Option<usize>

Returns the index of the first glyph run containing the given character index.

pub fn on_glyph_run_boundary(&self, index: ByteIndex) -> bool

pub fn range_index_of_advance( &self, range: &Range<ByteIndex>, advance: Au, ) -> usize

Returns the index in the range of the first glyph advancing over given advance

pub fn natural_word_slices_in_range( &'a self, range: &Range<ByteIndex>, ) -> NaturalWordSliceIterator<'a>

Returns an iterator that will iterate over all slices of glyphs that represent natural words in the given range.

pub fn natural_word_slices_in_visual_order( &'a self, range: &Range<ByteIndex>, ) -> NaturalWordSliceIterator<'a>

Returns an iterator that over natural word slices in visual order (left to right or right to left, depending on the bidirectional embedding level).

pub fn character_slices_in_range( &'a self, range: &Range<ByteIndex>, ) -> CharacterSliceIterator<'a>

Returns an iterator that will iterate over all slices of glyphs that represent individual characters in the given range.

Trait Implementations

impl Clone for TextRun

fn clone(&self) -> TextRun

Returns a copy 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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TextRun

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for TextRun

fn drop(&mut self)

Executes the destructor for this type.

impl Serialize for TextRun

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

where __S: Serializer,

Serialize this value into the given Serde serializer.