Struct Builder 

pub struct Builder { /* private fields */ }

A builder to construct AnnotatedString.

Implementations

impl Builder

pub fn new() -> Self

Creates a builder with no text.

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

Appends the given String to this Builder.

pub fn append_annotated(self, annotated: &AnnotatedString) -> Self

Appends the text of annotated together with its styles and annotations.

pub fn append_annotated_subsequence( self, annotated: &AnnotatedString, range: Range<usize>, ) -> Self

Appends the bytes of annotated in range with the styles and annotations that overlap them. The range is clamped to the text and both ends must lie on character boundaries.

pub fn push_style(self, style: SpanStyle) -> Self

Applies the given SpanStyle to any appended text until a corresponding pop is called.

Returns the index of the pushed style, which can be passed to pop_to or used as an ID.

pub fn push_paragraph_style(self, style: ParagraphStyle) -> Self

Applies the given ParagraphStyle to any appended text until a corresponding pop is called.

pub fn push_string_annotation(self, tag: &str, annotation: &str) -> Self

Pushes a string annotation covering subsequent appended text until the matching pop.

JC parity: Builder.pushStringAnnotation(tag, annotation)

pub fn push_link(self, link: LinkAnnotation) -> Self

Pushes a LinkAnnotation covering subsequent appended text. Call pop when done, or use with_link for the block form.

JC parity: Builder.pushLink(link)

pub fn with_link( self, link: LinkAnnotation, block: impl FnOnce(Self) -> Self, ) -> Self

Block form of push_link — mirrors JC’s withLink(link) { ... } DSL.

Example

builder
    .append("Visit ")
    .with_link(
        LinkAnnotation::Url("https://developer.android.com".into()),
        |b| b.append("Android Developers"),
    )
    .append(".")
    .to_annotated_string()

pub fn pop(self) -> Self

Ends the style that was most recently pushed.

pub fn to_annotated_string(self) -> AnnotatedString

Completes the builder, resolving open styles to the end of the text.

Trait Implementations

impl Clone for Builder

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 Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.