Struct Line

pub struct Line { /* private fields */ }

A line of text that has styling and can be displayed.

Implementations

impl Line

pub fn new(item: impl Into<Label>) -> Line

Create a new line.

pub fn blank() -> Line

Create a blank line.

pub fn style(self, style: Style) -> Line

Return a styled line by styling all its labels.

pub fn spaced(items: impl IntoIterator<Item = Label>) -> Line

Return a line with a single space between the given labels.

pub fn item(self, item: impl Into<Label>) -> Line

Add an item to this line.

pub fn extend(self, items: impl IntoIterator<Item = Label>) -> Line

Add multiple items to this line.

pub fn push(&mut self, item: impl Into<Label>)

Add an item to this line.

pub fn pad(&mut self, width: usize)

Pad this line to occupy the given width.

pub fn truncate(&mut self, width: usize, delim: &str)

Truncate this line to the given width.

pub fn width(&self) -> usize

Get the actual column width of this line.

pub fn space(self) -> Line

Create a line that contains a single space.

pub fn boxed(self) -> Box<dyn Element>

Box this line as an Element.

pub fn filled(self, color: Color) -> Filled<Line>

Return a filled line.

Trait Implementations

impl Cell for Line

type Truncated = Line

Type after truncation.

type Padded = Line

Type after padding.

fn width(&self) -> usize

Cell display width in number of terminal columns.

fn pad(&self, width: usize) -> <Line as Cell>::Padded

Pad the cell so that it is the given width, while keeping the content left-aligned.

fn truncate(&self, width: usize, delim: &str) -> <Line as Cell>::Truncated

Truncate cell if longer than given width. Shows the delimiter if truncated.

fn background(&self) -> Color

Background color of cell.

impl Clone for Line

fn clone(&self) -> Line

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<(), Error>

Formats the value using the given formatter.

impl Default for Line

fn default() -> Line

Returns the “default value” for a type.

impl Display for Line

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

Formats the value using the given formatter.

impl Element for Line

fn size(&self, _parent: Constraint) -> Size

Get the size of the element, in rows and columns.

fn render(&self, _parent: Constraint) -> Vec<Line>

Render the element as lines of text that can be printed.

fn columns(&self, parent: Constraint) -> usize

Get the number of columns occupied by this element.

fn rows(&self, parent: Constraint) -> usize

Get the number of rows occupied by this element.

fn print(&self)

Print this element to stdout.

fn write(&self, constraints: Constraint) -> Result<(), Error>

where Self: Sized,

Write using the given constraints to stdout.

fn display(&self, constraints: Constraint) -> String

Return a string representation of this element.

impl<T> From<T> for Line

where T: Into<Label>,

fn from(value: T) -> Line

Converts to this type from the input type.

impl From<Vec<Label>> for Line

fn from(items: Vec<Label>) -> Line

Converts to this type from the input type.

impl IntoIterator for Line

type Item = Label

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = Label>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Line as IntoIterator>::IntoIter

Creates an iterator from a value.