Struct AttributedString 

pub struct AttributedString { /* private fields */ }

Text with optional style runs and links.

Implementations

impl AttributedString

pub fn plain(text: impl Into<String>) -> Self

Create plain text with no runs or links.

pub fn new( text: impl Into<String>, runs: Vec<StyleRun>, links: Vec<LinkRun>, ) -> Result<Self, AttributedError>

Create an attributed string from parts. Validates every range against the text (bounds + UTF-8 boundaries).

pub fn text(&self) -> &str

The plain text.

pub fn runs(&self) -> &[StyleRun]

The style runs in wire order.

pub fn links(&self) -> &[LinkRun]

The links in wire order.

pub fn is_plain(&self) -> bool

Whether this carries no runs or links.

pub fn push_run(&mut self, run: StyleRun) -> Result<(), AttributedError>

Append a style run, validating it against the current text.

pub fn push_link(&mut self, link: LinkRun) -> Result<(), AttributedError>

Append a link, validating it against the current text.

pub fn validate(&self) -> Result<(), AttributedError>

Validate all ranges.

pub fn encode(&self) -> Result<Vec<u8>, AttributedError>

Encode the arena payload (without the outer [u32 byteLength] wrapper the arena adds). The caller allocates the returned bytes in the arena or the network string section.

pub fn encode_into(&self, out: &mut Vec<u8>) -> Result<(), AttributedError>

Encode into an existing buffer.

pub fn decode(bytes: &[u8]) -> Result<Self, AttributedError>

Decode an arena payload (the bytes inside the arena’s length wrapper).

pub fn segments(&self) -> Vec<AttributedSegment<'_>>

Split the text into non-overlapping segments, resolving overlapping runs in wire order (later wins per property; later link wins).

Trait Implementations

impl Clone for AttributedString

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 AttributedString

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

Formats the value using the given formatter.

impl Default for AttributedString

fn default() -> Self

Returns the “default value” for a type.

impl Eq for AttributedString

impl From<&str> for AttributedString

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for AttributedString

fn from(value: String) -> Self

Converts to this type from the input type.

impl PartialEq for AttributedString

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AttributedString