Struct tui::text::Text

pub struct Text<'a> {
    pub lines: Vec<Spans<'a>>,
}

A string split over multiple lines where each line is composed of several clusters, each with their own style.

A Text, like a Span, can be constructed using one of the many From implementations or via the Text::raw and Text::styled methods. Helpfully, Text also implements core::iter::Extend which enables the concatenation of several Text blocks.

let style = Style::default().fg(Color::Yellow).add_modifier(Modifier::ITALIC);

// An initial two lines of `Text` built from a `&str`
let mut text = Text::from("The first line\nThe second line");
assert_eq!(2, text.height());

// Adding two more unstyled lines
text.extend(Text::raw("These are two\nmore lines!"));
assert_eq!(4, text.height());

// Adding a final two styled lines
text.extend(Text::styled("Some more lines\nnow with more style!", style));
assert_eq!(6, text.height());

Fields

lines: Vec<Spans<'a>>

Implementations

impl<'a> Text<'a>

pub fn raw<T>(content: T) -> Text<'a> where
    T: Into<Cow<'a, str>>, 

Create some text (potentially multiple lines) with no style.

Examples

Text::raw("The first line\nThe second line");
Text::raw(String::from("The first line\nThe second line"));

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

Create some text (potentially multiple lines) with a style.

Examples

let style = Style::default().fg(Color::Yellow).add_modifier(Modifier::ITALIC);
Text::styled("The first line\nThe second line", style);
Text::styled(String::from("The first line\nThe second line"), style);

pub fn width(&self) -> usize

Returns the max width of all the lines.

Examples

use tui::text::Text;
let text = Text::from("The first line\nThe second line");
assert_eq!(15, text.width());

pub fn height(&self) -> usize

Returns the height.

Examples

use tui::text::Text;
let text = Text::from("The first line\nThe second line");
assert_eq!(2, text.height());

pub fn patch_style(&mut self, style: Style)

Apply a new style to existing text.

Examples

let style = Style::default().fg(Color::Yellow).add_modifier(Modifier::ITALIC);
let mut raw_text = Text::raw("The first line\nThe second line");
let styled_text = Text::styled(String::from("The first line\nThe second line"), style);
assert_ne!(raw_text, styled_text);

raw_text.patch_style(style);
assert_eq!(raw_text, styled_text);

Trait Implementations

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

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

Returns a copy 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() -> Text<'a>

Returns the “default value” for a type.

impl<'a> Extend<Spans<'a>> for Text<'a>

fn extend<T: IntoIterator<Item = Spans<'a>>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

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

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

Converts to this type from the input type.

impl<'a> From<Cow<'a, str>> for Text<'a>

fn from(s: Cow<'a, str>) -> Text<'a>

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

fn from(spans: Spans<'a>) -> Text<'a>

Converts to this type from the input type.

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

fn from(s: String) -> Text<'a>

Converts to this type from the input type.

impl<'a> From<Vec<Spans<'a>, Global>> for Text<'a>

fn from(lines: Vec<Spans<'a>>) -> Text<'a>

Converts to this type from the input type.

impl<'a> IntoIterator for Text<'a>

type Item = Spans<'a>

The type of the elements being iterated over.

type IntoIter = IntoIter<<Text<'a> as IntoIterator>::Item, Global>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> PartialEq<Text<'a>> for Text<'a>

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

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

fn ne(&self, other: &Text<'a>) -> bool

This method tests for !=.

impl<'a> Eq for Text<'a>

impl<'a> StructuralEq for Text<'a>

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