Struct AnnotatedString 

pub struct AnnotatedString {
    pub text: String,
    pub span_styles: Vec<RangeStyle<SpanStyle>>,
    pub paragraph_styles: Vec<RangeStyle<ParagraphStyle>>,
    pub string_annotations: Vec<RangeStyle<StringAnnotation>>,
    pub link_annotations: Vec<RangeStyle<LinkAnnotation>>,
}

The basic data structure of text with multiple styles.

To construct an AnnotatedString you can use AnnotatedString::builder().

Fields

text: String

span_styles: Vec<RangeStyle<SpanStyle>>

paragraph_styles: Vec<RangeStyle<ParagraphStyle>>

string_annotations: Vec<RangeStyle<StringAnnotation>>

Arbitrary tag+value annotations. Used for e.g. clickable link URLs. Mirrors JC AnnotatedString.getStringAnnotations(tag, start, end).

link_annotations: Vec<RangeStyle<LinkAnnotation>>

Link annotations — URLs and clickable actions. Mirrors JC AnnotatedString.getLinkAnnotations(start, end).

Implementations

impl AnnotatedString

pub fn new(text: String) -> Self

pub fn builder() -> Builder

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn span_boundaries(&self) -> SpanBoundaries

Returns a sorted list of unique byte indices where styles change.

pub fn render_string(&self) -> RenderString

Returns the RenderString view of this string: everything rendering reads (content, styles, link identity), nothing it must not touch (link handlers). A clone-conversion — memoize at the call site when the same AnnotatedString lowers every frame.

pub fn span_measurement_hash(&self) -> u64

Hash of the span styles’ ranges and the attributes that change how the text measures: two strings with the same text and hash measure alike, whatever their spans’ colors, backgrounds or decorations.

pub fn render_hash(&self) -> u64

pub fn subsequence(&self, range: Range<usize>) -> Self

Returns a new AnnotatedString containing a substring of the original text and any styles that overlap with the new range, with indices adjusted.

pub fn get_string_annotations( &self, tag: &str, start: usize, end: usize, ) -> Vec<&RangeStyle<StringAnnotation>>

Returns all string annotations with the given tag whose range overlaps [start, end).

JC parity: AnnotatedString.getStringAnnotations(tag, start, end) -> List<Range<String>>

pub fn get_link_annotations( &self, start: usize, end: usize, ) -> Vec<&RangeStyle<LinkAnnotation>>

Returns all link annotations whose range overlaps [start, end).

JC parity: AnnotatedString.getLinkAnnotations(start, end)

Trait Implementations

impl Clone for AnnotatedString

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 AnnotatedString

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

Formats the value using the given formatter.

impl Default for AnnotatedString

fn default() -> Self

Returns the “default value” for a type.

impl From<&String> for AnnotatedString

fn from(text: &String) -> Self

Converts to this type from the input type.

impl From<&mut String> for AnnotatedString

fn from(text: &mut String) -> Self

Converts to this type from the input type.

impl From<&str> for AnnotatedString

fn from(text: &str) -> Self

Converts to this type from the input type.

impl From<String> for AnnotatedString

fn from(text: String) -> Self

Converts to this type from the input type.

impl PartialEq for AnnotatedString

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AnnotatedString