Struct Line 

pub struct Line { /* private fields */ }

A list of spans that sit on one terminal line.

The text of a line is the text of its spans, joined. Its Display prints that text without styles, which suits tests and plain output. Build one with Line::from(span), or collect spans into it.

Implementations

impl Line

pub fn new() -> Self

An empty line.

pub fn push(&mut self, span: Span)

Adds span at the end of the line.

A span in the style of the line’s last span joins it. So two lines with the same text and styles are equal, however their spans were pushed.

The start of span can continue the line’s last grapheme cluster, as a combining mark or the rest of a ZWJ emoji sequence does. Those characters join the previous span and take its style, because a terminal cannot style part of a cluster.

So no cluster crosses a span boundary, and every width counts the cluster once. An empty span adds nothing, so none can sit between a cluster’s parts.

pub fn spans(&self) -> &[Span]

The spans, in order. Their text joined is the text of the line.

pub fn width(&self) -> u16

The width of the line in terminal cells. A width over u16::MAX saturates.

pub fn is_empty(&self) -> bool

Whether the line holds no text.

pub fn trim_end(&mut self)

Removes the spaces at the end of the line, and any span they empty.

A no-break space (U+00A0, U+2007, or U+202F) is not a space here, so it stays.

impl Line

pub fn truncate(&self, width: u16) -> Self

The line cut to exactly width cells and ended with ELLIPSIS, or the line itself when it fits.

The text is cut at a cluster boundary. A wide cluster that straddles the cut is replaced by a space, so a cut line is never narrower than width. The padding and the ellipsis take the style of the text they replace. A width of 0 gives an empty line.

pub fn fit(&self, width: u16, overflow: Overflow) -> Vec<Self>

The line fitted to width cells by overflow: wrapped into lines for Overflow::KeepWords and Overflow::Fold, or cut into one line for Overflow::Ellipsis.

A wrapped line never ends in a space: the spaces at the end of the line and at each break are dropped. An ellipsis line that fits keeps the spaces it ends with, as Line::truncate does. Call trim_end first; Text does this for you. A width of 0 counts as 1 when wrapping.

Trait Implementations

impl Clone for Line

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Line

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

Formats the value using the given formatter.

impl Default for Line

fn default() -> Self

Returns the “default value” for a type.

impl Display for Line

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

Formats the value using the given formatter.

impl Eq for Line

impl Extend<Span> for Line

fn extend<I: IntoIterator<Item = Span>>(&mut self, spans: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: T)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<Span> for Line

fn from(span: Span) -> Self

Converts to this type from the input type.

impl FromIterator<Span> for Line

fn from_iter<I: IntoIterator<Item = Span>>(spans: I) -> Self

Creates a value from an iterator.

impl Hash for Line

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Line

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Line