Struct tty_interface::line::Line

pub struct Line { /* private fields */ }

A line composed of text segments. Accumulates changes until applied by its parent Interface. May be obtained from the Interface API.

Implementations

impl Line

pub fn identifier(&self) -> LineId

This line’s unique identifier.

pub fn segment_ids(&self) -> &Vec<SegmentId>

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

pub fn segments(&self) -> Vec<&Segment>

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

pub fn get_segments(&self, ids: &Vec<SegmentId>) -> Result<Vec<&Segment>>

Retrieves several segment references by their identifiers.

pub fn get_segment(&self, id: &SegmentId) -> Result<&Segment>

Retrieves a segment reference by its identifier.

pub fn get_segment_mut(&mut self, id: &SegmentId) -> Result<&mut Segment>

Retrieves a mutable segment reference by its identifier.

pub fn get_segment_index(&self, id: &SegmentId) -> Result<usize>

Determines the specified segment’s index in this line.

pub fn add_segment(&mut self) -> &mut Segment

Appends a new text segment to this line. The text segment addition will be staged until changes are applied for this line’s Interface. Note that the returned segment may have other changes staged against it for the same update.

pub fn insert_segment(&mut self, index: usize) -> Result<&mut Segment>

Inserts a new text segment in this line at a specified index. The segment insertion will be staged until changes are applied for this line’s Interface. Note that the returned segment may have other changes staged against it for the same update.

pub fn remove_segment(&mut self, id: &SegmentId) -> Result<()>

Removes a text segment with the specified identifier from this line. The segment removal will be staged until changes are applied for this line’s Interface.

pub fn remove_segment_at(&mut self, index: usize) -> Result<SegmentId>

Removes a text segment from this line at the specified index. The segment removal will be staged until changes are applied for this line’s Interface.

pub fn has_changes(&self) -> bool

Whether this line or its text segments have any staged changes.

Trait Implementations

impl Debug for Line

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

Formats the value using the given formatter.