Struct TextRun 

pub struct TextRun {

    pub index: ObjectIndex,
    pub font: Arc<Font>,
    pub font_size: f32,
    pub font_size_h: f32,
    pub char_space: f32,
    pub word_space: f32,
    pub items: Vec<Item>,
    pub kernings: Vec<f32>,
    pub position: Point,
    pub text_matrix: Affine,
    pub rect: Rect,
    pub advance: f64,
    pub marks: ContentMarks,
    pub type3: BTreeMap<u32, Type3Metrics>,
}

A text object with everything the heuristics ask of it.

Built once per object per page and then read many times, because almost every decision in the pipeline needs at least the first and last item.

Fields

index: ObjectIndex

Where this object sits in the page’s flattened walk.

font: Arc<Font>

The font, shared with every other object using the same resource — duplicate suppression compares fonts by this pointer’s identity.

font_size: f32

The font size. May be negative, and is never rescued.

font_size_h: f32

|hypot(a, b)| * font_size of the composed matrix: “the horizontal scale of the font in device units”, which every space threshold is measured in.

char_space: f32

Tc, the character spacing.

word_space: f32

Tw, the word spacing.

items: Vec<Item>

One entry per glyph, in content order.

kernings: Vec<f32>

The adjustment following each glyph, in thousandths of a text-space unit. Same length as items; the last is always zero.

position: Point

The object’s position in page space.

text_matrix: Affine

The composed text matrix: the object’s linear transform with its position as the translation.

rect: Rect

The object’s bounding box in page space, stroke-inflated when the render mode strokes.

advance: f64

Total advance width in page space: w0 summed over the object’s glyphs (ISO 32000-1 §9.4.3), measured through the same text matrix the bounding box goes through, so the two are comparable against one epsilon.

§9.2.2 keeps the glyph bounding box and the §9.4.3 displacement distinct, and only the displacement says whether the pen moved. A space, and any glyph whose outline is empty, has an empty box and a non-zero w0; a zero-width space has both empty.

marks: ContentMarks

The marks enclosing the object.

type3: BTreeMap<u32, Type3Metrics>

What each shown character’s Type 3 glyph procedure declared, empty for every other kind of font. A Type 3 glyph’s box and advance live inside a content stream, so they arrive from the page layer rather than from the font.

Implementations

impl TextRun

pub fn count(&self) -> usize

How many glyphs the object shows.

pub fn item(&self, index: usize) -> Option<Item>

One glyph, or None past the end.

pub fn kerning(&self, index: usize) -> f32

The adjustment following a glyph; zero past the end.

pub fn scaled_char_width(&self, code: CharCode) -> f32

The advance width of one character code, already scaled by font_size / 1000.

A vertical CID font reports its (negative) vertical advance instead.

pub fn glyph_width(&self, code: CharCode) -> f32

The advance width of one character code in glyph units.

A Type 3 font whose /Widths said nothing defers to what the glyph procedure’s d0/d1 declared, which is the only place the number exists.

pub fn glyph_bbox(&self, code: CharCode) -> Rect

The bounding box of one character code in glyph units, y-up.

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

Formats the value using the given formatter.