Struct Segment 

pub struct Segment {
    pub text: String,
    pub style: Option<Style>,
    pub control: Option<ControlCode>,
}

A piece of text with an associated style.

Segments are produced during rendering and ultimately converted to strings for terminal output.

Fields

text: String

style: Option<Style>

control: Option<ControlCode>

Implementations

impl Segment

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

Create a new segment with just text.

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

Create a segment with text and style.

pub fn control(code: ControlCode) -> Self

Create a control-only segment.

pub fn line() -> Self

Create a newline segment.

pub fn cell_length(&self) -> usize

Get the cell length of this segment’s text (using Unicode width).

pub fn is_empty(&self) -> bool

Check if this segment has any text content.

pub fn split(&self, offset: usize) -> (Segment, Option<Segment>)

Split this segment at the given offset, returning two segments. The first goes up to (but not including) offset, the second from offset to end.

pub fn to_ansi(&self) -> String

Return the ANSI string for this segment (style + text + reset).

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 Display for Segment

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

Formats the value using the given formatter.

impl From<Segment> for RenderItem

fn from(s: Segment) -> Self

Converts to this type from the input type.

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 StructuralPartialEq for Segment