Struct liso::Line

pub struct Line { /* private fields */ }

This is a line of text, with optional styling information, ready for display. The liso! macro is extremely convenient for building these. You can also pass a String, &str, or Cow<str> to most Liso functions that accept a Line.

Implementations

impl Line

pub fn new() -> Line

Creates a new, empty line.

pub fn from_cow(i: Cow<'_, str>) -> Line

Creates a new line, containing the given, unstyled, text. Creates a new copy iff the passed Cow is borrowed or contains control characters.

pub fn from_str(i: &str) -> Line

Creates a new line, containing the given, unstyled, text. Always copies the passed string.

pub fn from_string(i: String) -> Line

Creates a new line, containing the given, unstyled, text. Creates a new copy iff the passed String contains control characters.

pub fn as_str(&self) -> &str

Returns all the text in the line, without any styling information.

pub fn add_text<'a, T>(&mut self, i: T) -> &mut Linewhere T: Into<Cow<'a, str>>,

Adds additional text to the Line using the currently-active Style and Colors..

You may pass a String, &str, or Cow<str> here, but not a Line. If you want to append styled text, see append_line. If you want to append the text from a Line but discard its style information, call as_str on that Line.

pub fn get_style(&self) -> Style

Returns the currently active Style.

pub fn set_style(&mut self, nu: Style) -> &mut Line

Change the active Style to exactly that given.

pub fn toggle_style(&mut self, nu: Style) -> &mut Line

Toggle every given Style.

pub fn activate_style(&mut self, nu: Style) -> &mut Line

Activate the given Styles, leaving any already-active Styles active.

pub fn deactivate_style(&mut self, nu: Style) -> &mut Line

Deactivate the given Styles, without touching any unmentioned Styles that were already active.

pub fn clear_style(&mut self) -> &mut Line

Deactivate all Styles. Same as calling set_style(Style::PLAIN).

pub fn get_colors(&self) -> (Option<Color>, Option<Color>)

Gets the current Colors, both foreground and background.

pub fn set_fg_color(&mut self, nu: Option<Color>) -> &mut Line

Sets the foreground Color.

pub fn set_bg_color(&mut self, nu: Option<Color>) -> &mut Line

Sets the background Color.

pub fn set_colors(&mut self, fg: Option<Color>, bg: Option<Color>) -> &mut Line

Sets both the foreground and background Color.

pub fn reset_all(&mut self) -> &mut Line

Reset ALL Style and Color information to default. Equivalent to:

line.set_style(Style::PLAIN).set_colors(None, None);

(In fact, that is the body of this function.)

pub fn is_empty(&self) -> bool

Returns true if this line contains no text. (It may yet contain some Style or Color information.)

pub fn len(&self) -> usize

Returns the number of BYTES of text this line contains.

pub fn chars(&self) -> LineCharIterator<'_>

Iterate over chars of the line, including Style and Color information, one char at a time.

The usual caveats about the difference between a char and a character apply. Unicode etc.

Yields: (byte_index, character, style, fgcolor, bgcolor)

pub fn reset_and_break(&mut self)

Add a linebreak and then clear Style and Colors.

Equivalent to:

line.add_text("\n");
line.set_style(Style::empty());
line.set_colors(None, None);

(In fact, that is the body of this function.)

pub fn append_line(&mut self, other: &Line)

Append another Line to ourselves, including Style and Color information. You may want to reset_and_break first.

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

Insert linebreaks as necessary to make it so that no line within this Line is wider than the given number of columns. Only available with the wrap feature, which is enabled by default.

Rather than calling this method yourself, you definitely want to use the wrapln method instead of the println method. That way, Liso will automatically wrap the line of text to the correct width for the user’s terminal.

Trait Implementations

impl Clone for Line

fn clone(&self) -> Line

Returns a copy 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 Into<Line> for &str

fn into(self) -> Line

Converts this type into the (usually inferred) input type.

impl Into<Line> for Cow<'_, str>

fn into(self) -> Line

Converts this type into the (usually inferred) input type.

impl Into<Line> for String

fn into(self) -> Line

Converts this type into the (usually inferred) input type.

impl PartialEq<Line> for Line

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Line

impl StructuralEq for Line

impl StructuralPartialEq for Line