Struct Label

pub struct Label(/* private fields */);

A styled string that does not contain any '\n' and implements Element and Cell.

Implementations

impl Label

pub fn new(s: &str) -> Self

Create a new label.

pub fn blank() -> Self

Create a blank label.

pub fn is_blank(&self) -> bool

Is this label empty.

pub fn content(&self) -> &str

Get unstyled content.

pub fn space() -> Self

Create a single space label

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

Box the label.

pub fn fg(self, color: Color) -> Self

Color the label’s foreground.

pub fn bg(self, color: Color) -> Self

Color the label’s background.

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

Style a label.

pub fn paint(&self) -> &Paint<String>

Get inner paint object.

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

Return a filled cell from this label.

pub fn to_line(self) -> Line

Wrap into a line.

Trait Implementations

impl Cell for Label

type Padded = Label

Type after padding.

type Truncated = Label

Type after truncation.

fn background(&self) -> Color

Background color of cell.

fn pad(&self, width: usize) -> Self::Padded

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

fn truncate(&self, width: usize, delim: &str) -> Self::Truncated

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

fn width(&self) -> usize

Cell display width in number of terminal columns.

impl Clone for Label

fn clone(&self) -> Label

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Label

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

Formats the value using the given formatter.

impl Default for Label

fn default() -> Label

Returns the “default value” for a type.

impl Display for Label

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

Formats the value using the given formatter.

impl Element for Label

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

where Self: Sized,

Write using the given constraints to stdout.

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

Return a string representation of this element.

impl From<&str> for Label

fn from(value: &str) -> Self

Converts to this type from the input type.

impl<D: Display> From<Paint<D>> for Label

fn from(paint: Paint<D>) -> Self

Converts to this type from the input type.

impl From<String> for Label

fn from(value: String) -> Self

Converts to this type from the input type.