Struct Text 

pub struct Text { /* private fields */ }

multi-line Unicode text; cosmic-text is the sole paragraph shaper, while unhinted skrifa outlines enter the ordinary shared fill pipeline.

Implementations

impl Text

pub fn fit_lines( &self, max_lines: usize, fonts: &FontLibrary, ) -> Result<(Self, bool), ValidationError>

Precomputes a paragraph limited to 1..=512 lines, adding an ellipsis only when truncated. Returns the text and whether source content was removed. Rich styles and extended grapheme boundaries are retained. The supplied font snapshot is frozen on the returned text; no system discovery occurs. Preparation may reshape bounded suffix candidates and is not a frame-loop API.

pub fn layout( &self, fonts: &FontLibrary, ) -> Result<Arc<ParagraphLayout>, ValidationError>

Shapes once per text-style/font snapshot, returning actual line/ink metrics.

impl Text

pub fn try_animate_parts_at( &self, context: &SceneContext<'_>, delay: Duration, style: impl Fn(&TextPart) -> PartStyle, ) -> Result<Node, ValidationError>

Evaluates part styles synchronously at explicit scene-local signed time, without reshaping for animation. Source bounds and line wrapping stay fixed; returned node bounds also include transformed animation ink. Measured paragraph baseline is retained for horizontal Row alignment.

impl Text

pub fn from_font( text: &str, font: &FontFace, size: f64, paint: impl Into<Paint>, ) -> Result<Self, ValidationError>

Builds and validates text using one explicit immutable font face.

pub fn new(text: impl Into<Arc<str>>) -> Self

Creates a paragraph with size 24, line height 1.3 and white fill.

pub fn rich(spans: impl IntoIterator<Item = TextSpan>) -> Self

Creates rich spans, whose unset styles inherit paragraph defaults.

pub fn family(self, family: impl Into<Arc<str>>) -> Self

Selects an explicit family; empty uses the library’s generic default.

pub fn size(self, size: f64) -> Self

Sets finite logical size in (0,4096].

pub fn weight(self, weight: FontWeight) -> Self

Selects OpenType weight; variable weight participates in glyph identity.

pub fn fill(self, paint: impl Into<Paint>) -> Self

Sets paint without invalidating shaped geometry.

pub fn stroke(self, width: f64, paint: impl Into<Paint>) -> Self

Adds stroke after filling; existing bounded stroke rules apply.

pub fn line_height(self, height: f64) -> Self

Sets a positive relative line-height multiplier.

pub fn letter_spacing(self, spacing: f64) -> Self

Sets logical tracking, converted to em internally for shaping.

pub fn max_width(self, width: f64) -> Self

Wraps to finite positive logical width.

pub fn alignment(self, alignment: TextAlignment) -> Self

Selects bidirectional-aware paragraph alignment.

pub fn fonts(self, fonts: &FontLibrary) -> Self

Binds an explicit font snapshot, overriding a DrawContext environment.

pub fn split(self, split: TextSplit) -> Self

Selects grapheme, word-boundary or wrapped-line parts.

pub fn visible_parts(self, count: usize) -> Self

Keeps original layout while drawing only the first logical parts.

pub fn write(self, progress: f64) -> Self

Defers vector handwriting to compilation with the current font environment.

pub fn animate_parts( self, delay: Duration, style: impl Fn(&TextPart) -> PartStyle + Send + Sync + 'static, ) -> Self

Defers per-part style evaluation to scene-local drawing time.

pub fn write_with_context( &self, progress: f64, context: &DrawContext, ) -> Result<Node, ValidationError>

Applies the common vector handwriting effect with default contour/fill handoff. Bind fonts on this Text or supply them in the DrawContext.

pub fn vector_tree( &self, context: &DrawContext, ) -> Result<Arc<VectorTree>, ValidationError>

Exports original shared glyph curves, color layers, bitmap strikes and source ranges into the common vector model. No second shaping pass occurs.

Trait Implementations

impl Clone for Text

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Text

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

Formats the value using the given formatter.

impl Drawable for Text

fn resolve_node( &self, context: &DrawContext, ) -> Result<Option<Node>, ValidationError>

Resolves deferred content to ordinary nodes at the current drawing time.

fn try_bounds(&self, context: &DrawContext) -> Result<Rect, ValidationError>

Checked bounds for fallible content such as explicit-font paragraphs. Existing geometry implementations may keep the infallible bounds method.

fn bounds(&self, context: &DrawContext) -> Rect

Local layout/ink bounds before node placement.

fn baseline(&self, context: &DrawContext) -> Option<f64>

Real horizontal text baseline in local coordinates; geometry has none.

fn draw( &self, context: &DrawContext, canvas: &mut Canvas<'_>, ) -> Result<(), ValidationError>

Emits local commands; validation errors propagate without partial output.