Struct Segment 

pub struct Segment {
    pub text: String,
    pub style: Style,
    pub is_control: bool,
}

A piece of styled text, the fundamental rendering unit.

Every widget’s render method produces lines of segments.

Fields

text: String

The text content.

style: Style

The style applied to this segment.

is_control: bool

Whether this is a control sequence (not visible text).

Implementations

impl Segment

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

Create a new segment with default style.

pub fn styled(text: impl Into<String>, style: Style) -> Self

Create a new segment with the given style.

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

Create a control segment (not rendered as visible text).

pub fn blank(width: u16) -> Self

Create a blank segment (spaces) of the given width.

pub fn width(&self) -> usize

Display width in terminal cells.

pub fn display_width(&self) -> usize

Display width in terminal cells (alias for width()).

pub fn is_empty(&self) -> bool

Returns true if the segment has no text.

pub fn grapheme_widths(&self) -> Vec<(String, usize)>

Returns each grapheme cluster in this segment together with its display width.

Combining marks (zero-width) are grouped with their base character into a single grapheme cluster by the Unicode segmentation algorithm.

pub fn char_count(&self) -> usize

Returns the number of grapheme clusters in this segment.

This counts user-perceived characters, so a base character followed by combining diacritics counts as one.

pub fn truncate_to_width(&self, max_width: usize) -> Segment

Truncate this segment to at most max_width display columns.

If the segment is already within max_width, returns an identical segment. If a wide character straddles the boundary, it is excluded (the result may be slightly shorter than max_width).

pub fn pad_to_width(&self, target_width: usize) -> Segment

Pad this segment with trailing spaces to reach target_width display columns.

If the segment is already at or wider than target_width, returns unchanged.

pub fn split_at(&self, offset: usize) -> (Segment, Segment)

Split this segment at the given display-width offset.

Returns (left, right) where left has the specified display width. If the offset falls in the middle of a wide character, the left side is padded with a space and the right side gets a leading space.

Combining marks (zero-width diacritics) are kept attached to their base character: if the split point falls between a base character and its combining marks, the combining marks travel with the base.

Trait Implementations

impl Clone for Segment

fn clone(&self) -> Segment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Segment

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

Formats the value using the given formatter.

impl PartialEq for Segment

fn eq(&self, other: &Segment) -> 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 Eq for Segment

impl StructuralPartialEq for Segment