Struct tty_interface::segment::Segment

pub struct Segment { /* private fields */ }

A segment of text which may have formatting. Accumulates changes until applied by its parent Line. May be obtained from the Line API.

Implementations

impl Segment

pub fn identifier(&self) -> SegmentId

This segment’s unique identifier.

pub fn text(&self) -> Option<&String>

This segment’s text. Reflects the latest state, even if staged changes have not yet been applied to the interface.

pub fn color(&self) -> Option<&Color>

This segment’s color. Reflects the latest state, even if staged changes have not yet been applied to the interface.

pub fn styles(&self) -> &Vec<Style>

This segment’s styles. Reflects the latest state, even if staged changes have not yet been applied to the interface.

pub fn set_text(&mut self, text: &str)

Update this segment’s text. The new text will be staged until applied for this Interface.

pub fn set_color(&mut self, color: Color)

Update this segment’s color. The new color is staged until applied for this Interface.

pub fn reset_color(&mut self)

Clear this segment’s color. The reset is staged until applied for this Interface.

pub fn set_styles(&mut self, styles: Vec<Style>)

Update this segment’s styles. The new styles are staged until applied for this Interface.

pub fn reset_styles(&mut self)

Clear this segment’s styles. The reset is staged until applied for this Interface.

pub fn has_changes(&self) -> bool

Whether this segment has any staged changes.

Trait Implementations

impl Debug for Segment

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

Formats the value using the given formatter.