Struct Span 

pub struct Span<'a> {
    pub content: Cow<'a, str>,
    pub style: Option<Style>,
    pub link: Option<Cow<'a, str>>,
}

A styled span of text.

Span is a simple wrapper around text and optional style, providing an ergonomic builder for creating styled text units.

Fields

content: Cow<'a, str>

The text content.

style: Option<Style>

Optional style for this span.

link: Option<Cow<'a, str>>

Optional hyperlink URL (OSC 8).

Implementations

impl<'a> Span<'a>

pub fn raw(content: impl Into<Cow<'a, str>>) -> Self

Create an unstyled span.

pub fn styled(content: impl Into<Cow<'a, str>>, style: Style) -> Self

Create a styled span.

pub fn link(self, link: impl Into<Cow<'a, str>>) -> Self

Set the hyperlink URL for this span.

pub fn as_str(&self) -> &str

Get the text content.

pub fn width(&self) -> usize

Get the display width in cells.

pub fn split_at_cell(&self, cell_pos: usize) -> (Self, Self)

Split the span at a cell position.

Returns (left, right) where the split respects grapheme boundaries.

pub fn measurement(&self) -> TextMeasurement

Return bounds-based measurement for this span.

pub fn is_empty(&self) -> bool

Check if the span is empty.

pub fn with_style(self, style: Style) -> Self

Apply a style to this span.

pub fn into_segment(self) -> Segment<'a>

Convert to a segment.

pub fn into_owned(self) -> Span<'static>

Convert to an owned span.

Trait Implementations

impl<'a> Clone for Span<'a>

fn clone(&self) -> Span<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Span<'a>

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

Formats the value using the given formatter.

impl Default for Span<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> From<&'a str> for Span<'a>

fn from(s: &'a str) -> Self

Converts to this type from the input type.

impl<'a> From<Segment<'a>> for Span<'a>

fn from(seg: Segment<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Span<'a>> for Line

fn from(span: Span<'a>) -> Self

Converts to this type from the input type.

impl From<String> for Span<'static>

fn from(s: String) -> Self

Converts to this type from the input type.

impl<'a> FromIterator<Span<'a>> for Text

fn from_iter<I: IntoIterator<Item = Span<'a>>>(iter: I) -> Self

Creates a value from an iterator.

impl<'a> PartialEq for Span<'a>

fn eq(&self, other: &Span<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> Eq for Span<'a>

impl<'a> StructuralPartialEq for Span<'a>