Struct Text 

pub struct Text<'a> {
    pub lines: Vec<Line<'a>>,
    pub style: Style,
}

Multi-line rich text.

Text can contain multiple lines, each with its own spans and alignment.

Example

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

let text = Text::from(vec![
    Line::from("First line"),
    Line::styled("Second line", Style::default().fg(Color::Blue)),
]);

Fields

lines: Vec<Line<'a>>

The lines that make up this text

style: Style

Overall style applied to all lines

Implementations

impl<'a> Text<'a>

pub fn new() -> Self

Create new empty text.

pub fn from_lines(lines: Vec<Line<'a>>) -> Self

Create text from lines.

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

Create styled text from a string.

pub fn width(&self) -> usize

Get the width of the widest line.

pub fn height(&self) -> usize

Get the number of lines.

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

Convert this text to an owned version.

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

Patch the style of this text (affects all lines).

pub fn push_line(&mut self, line: Line<'a>)

Push a line to this text.

pub fn extend_lines(&mut self, lines: impl IntoIterator<Item = Line<'a>>)

Extend this text with more lines.

Trait Implementations

impl<'a> Clone for Text<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Text<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Text<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, 'a> Deserialize<'de> for Text<'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 Text<'_>

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

Formats the value using the given formatter.

impl<'a> From<&'a str> for Text<'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 From<String> for Text<'static>

fn from(s: String) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'a> Hash for Text<'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 Text<'a>

fn eq(&self, other: &Text<'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 Text<'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 Text<'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 Text<'a>

impl<'a> StructuralPartialEq for Text<'a>