Struct Segment 

pub struct Segment {
    pub text: Cow<'static, str>,
    pub style: Option<Style>,
    pub meta: Option<StyleMeta>,
    pub control: Option<ControlType>,
}

A segment of text with optional style and control codes.

This is the fundamental unit of output in Rich. All renderables produce sequences of Segments.

Uses Cow<'static, str> for text to allow both owned and static strings without lifetime complexity in the API. This is a deliberate tradeoff favoring API simplicity over zero-copy for borrowed non-static input.

Fields

text: Cow<'static, str>

The text content.

style: Option<Style>

Optional style to apply.

meta: Option<StyleMeta>

Optional style metadata (hyperlinks, Textual handlers, etc.).

control: Option<ControlType>

Optional control code (if set, text is typically empty).

Implementations

impl Segment

pub fn new(text: impl Into<Cow<'static, str>>) -> Self

Create a new text segment.

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

Create a new styled segment.

pub fn styled_with_meta( text: impl Into<Cow<'static, str>>, style: Style, meta: StyleMeta, ) -> Self

Create a new styled segment with metadata.

pub fn new_with_meta( text: impl Into<Cow<'static, str>>, meta: StyleMeta, ) -> Self

Create a new segment with metadata and no style.

pub fn control(control: ControlType) -> Self

Create a control segment.

pub fn line() -> Self

Create a newline segment.

pub fn is_control(&self) -> bool

Check if this segment is a control segment.

pub fn cell_len(&self) -> usize

Get the cell width of this segment’s text.

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

Apply a style to this segment, combining with any existing style.

pub fn split_cells(&self, cut: usize) -> (Segment, Segment)

Split segment into two segments at the specified cell position.

If the cut point falls in the middle of a 2-cell wide character then it is replaced by two spaces, to preserve the display width of the parent segment.

Arguments

• cut - Cell offset within the segment to cut at.

Returns

A tuple of two segments: (before, after).

Example

use rich_rs::Segment;

let seg = Segment::new("hello");
let (before, after) = seg.split_cells(3);
assert_eq!(&*before.text, "hel");
assert_eq!(&*after.text, "lo");

pub fn split_lines( segments: impl IntoIterator<Item = Segment>, ) -> Vec<Vec<Segment>>

Split a sequence of segments into lines on newline characters.

Arguments

• segments - Segments potentially containing newlines.

Returns

A vector of lines, where each line is a vector of segments.

pub fn split_and_crop_lines( segments: impl IntoIterator<Item = Segment>, length: usize, style: Option<Style>, pad: bool, include_new_lines: bool, ) -> Vec<Vec<Segment>>

Split segments into lines and crop/pad each line to a specific length.

Arguments

• segments - An iterable of segments to process.
• length - Desired line length in cells.
• style - Style to use for padding.
• pad - Whether to pad lines shorter than length.
• include_new_lines - Whether to append newline segments to each line.

Returns

A vector of lines, each cropped/padded to the desired length.

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

Adjust a line to a given width by cropping or padding.

Arguments

• line - A slice of segments representing a single line.
• length - Desired width in cells.
• style - Style to use for padding.
• pad - Whether to pad lines shorter than length.

Returns

A new vector of segments with the desired length.

pub fn get_last_style(line: &[Segment]) -> Option<Style>

Get the last non-control style in a line.

This is useful for determining the “end of line” style when padding with spaces, so background colors extend to the full width.

pub fn simplify(segments: impl IntoIterator<Item = Segment>) -> Segments

Simplify segments by merging adjacent segments with the same style.

Arguments

• segments - An iterable of segments to simplify.

Returns

A Segments collection with adjacent same-style segments merged.

pub fn divide( segments: impl IntoIterator<Item = Segment>, cuts: &[usize], ) -> Vec<Vec<Segment>>

Divide segments at multiple cell positions.

Arguments

• segments - Segments to divide.
• cuts - Cell positions where to divide (must be sorted in ascending order).

Returns

A vector of segment vectors, one for each division. Always includes a trailing partition containing any remaining content after the last cut.

Panics (debug mode only)

Debug-asserts that cuts are sorted in ascending order.

pub fn apply_style_to_segments( segments: impl IntoIterator<Item = Segment>, style: Option<Style>, post_style: Option<Style>, ) -> Segments

Apply style to all segments.

Returns segments where the style is replaced by style + segment.style + post_style.

Arguments

• segments - Segments to process.
• style - Base style to apply first.
• post_style - Style to apply after segment’s own style.

Returns

A new Segments collection with styles applied.

pub fn filter_control( segments: impl IntoIterator<Item = Segment>, is_control: bool, ) -> Segments

Filter segments by control status.

Arguments

• segments - Segments to filter.
• is_control - If true, keep only control segments; if false, keep only non-control segments.

Returns

A new Segments collection with only matching segments.

pub fn strip_styles(segments: impl IntoIterator<Item = Segment>) -> Segments

Remove all styles from segments.

Arguments

• segments - Segments to process.

Returns

A new Segments collection with all styles removed.

pub fn get_line_length(line: &[Segment]) -> usize

Get the total cell width of a line of segments.

Arguments

• line - A slice of segments representing a single line (no newlines).

Returns

The total cell width of all non-control segments.

pub fn get_shape(lines: &[Vec<Segment>]) -> (usize, usize)

Get the shape (enclosing rectangle) of a list of lines.

Arguments

• lines - A list of lines (no newline characters).

Returns

A tuple of (width, height) representing the enclosing rectangle.

pub fn set_shape( lines: &[Vec<Segment>], width: usize, height: Option<usize>, style: Option<Style>, new_lines: bool, ) -> Vec<Vec<Segment>>

Set the shape of a list of lines to a specific rectangle.

Arguments

• lines - A list of lines.
• width - Desired width.
• height - Desired height (if None, uses current height).
• style - Style for padding.
• new_lines - Whether padded lines should include newline characters.

Returns

A new list of lines with the specified shape.

pub fn align_top( lines: &[Vec<Segment>], width: usize, height: usize, style: Option<Style>, new_lines: bool, ) -> Vec<Vec<Segment>>

Align lines to the top by padding the bottom with blank lines.

Arguments

• lines - A list of lines.
• width - Desired width of blank lines in cells.
• height - Desired total height.
• style - Style for padding.
• new_lines - Whether blank lines should include “\n”.

pub fn align_bottom( lines: &[Vec<Segment>], width: usize, height: usize, style: Option<Style>, new_lines: bool, ) -> Vec<Vec<Segment>>

Align lines to the bottom by padding the top with blank lines.

pub fn align_middle( lines: &[Vec<Segment>], width: usize, height: usize, style: Option<Style>, new_lines: bool, ) -> Vec<Vec<Segment>>

Align lines to the middle by padding top and bottom with blank lines.

pub fn split_lines_terminator( segments: impl IntoIterator<Item = Segment>, ) -> Vec<(Vec<Segment>, bool)>

Split segments into lines, preserving a boolean flag indicating whether a newline character was encountered (true) or end of content (false).

This is equivalent to Python Rich’s Segment.split_lines_terminator.

pub fn strip_links(segments: impl IntoIterator<Item = Segment>) -> Segments

Remove link metadata from segments.

This is equivalent to Python Rich’s Segment.strip_links.

pub fn remove_color(segments: impl IntoIterator<Item = Segment>) -> Segments

Remove color information from segments, keeping text and attributes.

This is equivalent to Python Rich’s Segment.remove_color.

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

fn default() -> Self

Returns the “default value” for a type.

impl From<&'static str> for Segment

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

Converts to this type from the input type.

impl From<Segment> for Segments

fn from(segment: Segment) -> Self

Converts to this type from the input type.

impl From<String> for Segment

fn from(s: String) -> Self

Converts to this type from the input type.

impl FromIterator<Segment> for Segments

fn from_iter<I: IntoIterator<Item = Segment>>(iter: I) -> Self

Creates a value from an iterator.

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