Enum Text 

pub enum Text {
    Str(String),
    Lines(Vec<Line>),
    Full {
        lines: Vec<Line>,
        style: Option<Style>,
        alignment: Option<Alignment>,
    },
}

ratatui Text: a string, an array of lines, or {lines, style?, alignment?}.

Variants

Str(String)

Shorthand: plain string (splits on \n).

Lines(Vec<Line>)

Shorthand: array of lines.

Full

Full form.

Fields

lines: Vec<Line>

Text lines.

style: Option<Style>

Text style.

alignment: Option<Alignment>

Text alignment.

Implementations

impl Text

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

Full-form text from lines.

pub fn lines(&self) -> Vec<Line>

The text’s lines (a shorthand string splits on \n).

pub fn style(&self) -> Option<&Style>

The text’s style, if any.

pub fn alignment(&self) -> Option<Alignment>

The text’s alignment, if any.

pub fn to_text(&self) -> String

Flattens to plain text joined by \n.

Trait Implementations

impl Clone for Text

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Text

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

Formats the value using the given formatter.

impl Default for Text

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Text

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for Text

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Line> for Text

fn from(line: Line) -> Self

Converts to this type from the input type.

impl From<Span> for Text

fn from(span: Span) -> Self

Converts to this type from the input type.

impl From<String> for Text

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Text> for ListItem

fn from(text: Text) -> Self

Converts to this type from the input type.

impl From<Text> for Cell

fn from(text: Text) -> Self

Converts to this type from the input type.

impl From<Vec<Line>> for Text

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

Converts to this type from the input type.

impl PartialEq for Text

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Text

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Text

impl Stylize<Text> for Text

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

Applies a style.

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

Sets the foreground token.

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

Sets the background token.

fn underline_color(self, color: Color) -> T

Sets the underline colour token.

fn bold(self) -> T

Adds the BOLD modifier.

fn dim(self) -> T

Adds the DIM modifier.

fn italic(self) -> T

Adds the ITALIC modifier.

fn underlined(self) -> T

Adds the UNDERLINED modifier.

fn slow_blink(self) -> T

Adds the SLOW_BLINK modifier.

fn rapid_blink(self) -> T

Adds the RAPID_BLINK modifier.

fn reversed(self) -> T

Adds the REVERSED modifier.

fn hidden(self) -> T

Adds the HIDDEN modifier.

fn crossed_out(self) -> T

Adds the CROSSED_OUT modifier.

impl Stylize<Text> for Vec<Line>

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

Applies a style.

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

Sets the foreground token.

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

Sets the background token.

fn underline_color(self, color: Color) -> T

Sets the underline colour token.

fn bold(self) -> T

Adds the BOLD modifier.

fn dim(self) -> T

Adds the DIM modifier.

fn italic(self) -> T

Adds the ITALIC modifier.

fn underlined(self) -> T

Adds the UNDERLINED modifier.

fn slow_blink(self) -> T

Adds the SLOW_BLINK modifier.

fn rapid_blink(self) -> T

Adds the RAPID_BLINK modifier.

fn reversed(self) -> T

Adds the REVERSED modifier.

fn hidden(self) -> T

Adds the HIDDEN modifier.

fn crossed_out(self) -> T

Adds the CROSSED_OUT modifier.