Struct Segment 

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

A span of text with an optional style. Mirrors rich.segment.Segment.

Fields

text: String

style: Option<Style>

control: bool

Whether this segment carries terminal control codes rather than content.

Implementations

impl Segment

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

A plain content segment.

pub fn line() -> Self

A newline segment (Segment.line() upstream).

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

A control segment (carries no visible width).

pub fn cell_length(&self) -> usize

The number of terminal cells this segment occupies (0 for control).

pub fn simplify(segments: &[Segment]) -> Vec<Segment>

Merge adjacent segments that share the same style and control flag. Port of Segment.simplify.

pub fn apply_style(segments: &[Segment], style: &Style) -> Vec<Segment>

Apply style as a base under each segment’s own style (that segment’s style wins on top). Control segments are left untouched. Port of Segment.apply_style (the style-only path).

Line-break segments ("\n") are also left unstyled: upstream’s line-oriented print pipeline re-emits row separators plain, so styling them would add stray SGR runs around every newline.

pub fn split_lines(segments: &[Segment]) -> Vec<Vec<Segment>>

Split a flat segment stream into lines, breaking on \n.

Port of Segment.split_lines. Newline characters are consumed (not kept in the output); a trailing newline yields a final empty line only if there was content after the last break.

pub fn set_shape( lines: Vec<Vec<Segment>>, width: usize, height: usize, ) -> Vec<Vec<Segment>>

Shape a set of lines into exactly height rows of width cells: crop extra rows, pad each row to width, and append blank rows to reach height. Port of Segment.set_shape (style=None, new_lines=False).

pub fn crop_lines(segments: &[Segment], width: usize) -> Vec<Segment>

Crop every line in a segment stream to at most width cells, discarding the excess and leaving short lines alone.

Port of Segment.split_and_crop_lines with pad=False, which is what Console.print(crop=True) applies to the finished stream. It is the only thing standing between an Overflow::Ignore text and a line that runs off the side of the terminal.

Control segments occupy no cells and are always kept, so cursor moves and hyperlink codes survive a crop.

pub fn adjust_line_length( line: &[Segment], length: usize, style: Option<Style>, ) -> Vec<Segment>

Pad (with a styled space run) or crop a single line to exactly length cells. Port of Segment.adjust_line_length.

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

impl PartialEq for Segment

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Segment