Skip to main content

AnnotatedString

Struct AnnotatedString 

Source
pub struct AnnotatedString {
    pub text: String,
    pub span_styles: Vec<RangeStyle<SpanStyle>>,
    pub paragraph_styles: Vec<RangeStyle<ParagraphStyle>>,
}
Expand description

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>>

Implementations§

Source§

impl AnnotatedString

Source

pub fn new(text: String) -> Self

Source

pub fn builder() -> Builder

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn span_boundaries(&self) -> Vec<usize>

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

Source

pub fn span_styles_hash(&self) -> u64

Computes a hash representing the contents of the span styles, suitable for cache invalidation.

Source

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.

Trait Implementations§

Source§

impl Clone for AnnotatedString

Source§

fn clone(&self) -> AnnotatedString

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AnnotatedString

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AnnotatedString

Source§

fn default() -> AnnotatedString

Returns the “default value” for a type. Read more
Source§

impl From<&String> for AnnotatedString

Source§

fn from(text: &String) -> Self

Converts to this type from the input type.
Source§

impl From<&mut String> for AnnotatedString

Source§

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

Converts to this type from the input type.
Source§

impl From<&str> for AnnotatedString

Source§

fn from(text: &str) -> Self

Converts to this type from the input type.
Source§

impl From<String> for AnnotatedString

Source§

fn from(text: String) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for AnnotatedString

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for AnnotatedString

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.