Struct BreakCursor 

pub struct BreakCursor<'a> {
    pub items: &'a [ShapedItem],
    pub next_item_index: usize,
    pub partial_remainder: Vec<ShapedItem>,
}

Fields

items: &'a [ShapedItem]

A reference to the complete list of shaped items.

next_item_index: usize

The index of the next full item to be processed from the items slice.

partial_remainder: Vec<ShapedItem>

The remainder of an item that was split by hyphenation on the previous line. This will be the very first piece of content considered for the next line.

Implementations

impl<'a> BreakCursor<'a>

pub fn new(items: &'a [ShapedItem]) -> Self

pub fn is_at_start(&self) -> bool

Checks if the cursor is at the very beginning of the content stream.

pub fn drain_remaining(&mut self) -> Vec<ShapedItem>

Consumes the cursor and returns all remaining items as a Vec.

pub fn is_done(&self) -> bool

Checks if all content, including any partial remainders, has been processed.

pub fn consume(&mut self, count: usize)

Consumes a number of items from the cursor’s stream.

pub fn peek_next_unit(&self) -> Vec<ShapedItem>

Looks ahead and returns the next “unbreakable” unit of content. This is typically a word (a series of non-space clusters) followed by a space, or just a single space if that’s next.