Struct RenderedSegment 

#[non_exhaustive]
pub struct RenderedSegment { /* private fields */ }

Output of a successful segment render.

Fields are pub(crate) so the engine can read them directly; external callers go through the constructors and accessors so the width == text_width(text) invariant can’t desync via a mutable text. #[non_exhaustive] keeps future additions SemVer-safe.

Implementations

impl RenderedSegment

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

Build a rendered segment from text, auto-computing its cell width. Use Self::with_separator when the segment wants to override its default right-separator for this boundary, and Self::with_role / Self::with_style to attach a theme role or full style.

pub fn with_separator(text: impl Into<String>, separator: Separator) -> Self

pub fn with_role(self, role: Role) -> Self

Chainable setter for the segment’s theme role. The layout engine resolves the role against the active theme + terminal capability at render time; no ANSI bytes land in text.

Preserves any decorations previously set by Self::with_style. Pair with with_style carefully: .with_style(s).with_role(r) keeps s’s bold/fg/etc. and swaps role, whereas .with_role(r).with_style(s) wholesale-replaces everything.

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

Chainable setter for the full style (role + decorations). Wholesale-replaces the current style; use Self::with_role when you want to preserve decorations and swap only the role.

pub fn style(&self) -> &Style

Style this segment wants applied when the layout emits it.

pub fn text(&self) -> &str

The rendered text.

pub fn width(&self) -> u16

Cell width of the rendered text.

pub fn right_separator(&self) -> Option<&Separator>

Separator this render prefers on its right edge, if any. None means “fall back to the segment’s default separator.”

Trait Implementations

impl Clone for RenderedSegment

fn clone(&self) -> RenderedSegment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenderedSegment

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

Formats the value using the given formatter.

impl PartialEq for RenderedSegment

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

impl StructuralPartialEq for RenderedSegment