Struct Line 

pub struct Line<'a> {
    pub spans: Vec<Span<'a>>,
    pub alignment: Alignment,
    pub style: Style,
}

A line of text composed of multiple styled spans.

A line represents a single row of text that can have multiple different styles.

Example

use tuxtui_core::text::{Line, Span};
use tuxtui_core::style::{Color, Style};

let line = Line::from(vec![
    Span::styled("Hello ", Style::default().fg(Color::Blue)),
    Span::styled("World!", Style::default().fg(Color::Red)),
]);

Fields

spans: Vec<Span<'a>>

The spans that make up this line

alignment: Alignment

Alignment for this line

style: Style

Line style applied to all spans

Implementations

impl<'a> Line<'a>

pub fn new() -> Self

Create a new empty line.

pub fn from_spans(spans: Vec<Span<'a>>) -> Self

Create a new line from spans.

pub fn styled<T: Into<Cow<'a, str>>>(content: T, style: Style) -> Self

Create a styled line from a string.

pub fn alignment(self, alignment: Alignment) -> Self

Set the alignment for this line.

pub fn width(&self) -> usize

Get the display width of this line.

pub fn truncate(self, max_width: usize, ellipsis: Option<&str>) -> Line<'a>

Truncate the line to fit within the given width, optionally adding an ellipsis.

Example

use tuxtui_core::text::Line;

let line = Line::from("This is a very long line");
let truncated = line.truncate(10, Some("..."));
assert!(truncated.width() <= 10);

pub fn into_owned(self) -> Line<'static>

Convert this line to an owned version.

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

Patch the style of this line (affects all spans).

pub fn push_span(&mut self, span: Span<'a>)

Push a span to this line.

Trait Implementations

impl<'a> Clone for Line<'a>

fn clone(&self) -> Line<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Line<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Line<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, 'a> Deserialize<'de> for Line<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Line<'_>

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

Formats the value using the given formatter.

impl<'a> From<&'a str> for Line<'a>

fn from(s: &'a str) -> Self

Converts to this type from the input type.

impl<'a> From<Line<'a>> for Text<'a>

fn from(line: Line<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Span<'a>> for Line<'a>

fn from(span: Span<'a>) -> Self

Converts to this type from the input type.

impl From<String> for Line<'static>

fn from(s: String) -> Self

Converts to this type from the input type.

impl<'a> From<Vec<Span<'a>>> for Line<'a>

fn from(spans: Vec<Span<'a>>) -> Self

Converts to this type from the input type.

impl<'a> Hash for Line<'a>

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<'a> PartialEq for Line<'a>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> Serialize for Line<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Stylize for Line<'a>

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

Apply a style to this item.

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

Set the foreground color.

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

Set the background color.

fn black(self) -> Self

Make the text black.

fn red(self) -> Self

Make the text red.

fn green(self) -> Self

Make the text green.

fn yellow(self) -> Self

Make the text yellow.

fn blue(self) -> Self

Make the text blue.

fn magenta(self) -> Self

Make the text magenta.

fn cyan(self) -> Self

Make the text cyan.

fn white(self) -> Self

Make the text white.

fn gray(self) -> Self

Make the text gray.

fn bold(self) -> Self

Make the text bold.

fn dim(self) -> Self

Make the text dim.

fn italic(self) -> Self

Make the text italic.

fn underlined(self) -> Self

Make the text underlined.

fn slow_blink(self) -> Self

Make the text blink slowly.

fn rapid_blink(self) -> Self

Make the text blink rapidly.

fn reversed(self) -> Self

Reverse the foreground and background colors.

fn hidden(self) -> Self

Make the text hidden.

fn crossed_out(self) -> Self

Make the text crossed out.

impl<'a> Eq for Line<'a>

impl<'a> StructuralPartialEq for Line<'a>