Struct ratatui::text::Line

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

Fields

spans: Vec<Span<'a>>

alignment: Option<Alignment>

Implementations

impl<'a> Line<'a>

pub fn width(&self) -> usize

Returns the width of the underlying string.

Examples

let line = Line::from(vec![
    Span::styled("My", Style::default().fg(Color::Yellow)),
    Span::raw(" text"),
]);
assert_eq!(7, line.width());

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

Patches the style of each Span in an existing Line, adding modifiers from the given style.

Examples

let style = Style::default().fg(Color::Yellow).add_modifier(Modifier::ITALIC);
let mut raw_line = Line::from(vec![
    Span::raw("My"),
    Span::raw(" text"),
]);
let mut styled_line = Line::from(vec![
    Span::styled("My", style),
    Span::styled(" text", style),
]);

assert_ne!(raw_line, styled_line);

raw_line.patch_style(style);
assert_eq!(raw_line, styled_line);

pub fn reset_style(&mut self)

Resets the style of each Span in the Line. Equivalent to calling patch_style(Style::reset()).

Examples

let mut line = Line::from(vec![
    Span::styled("My", Style::default().fg(Color::Yellow)),
    Span::styled(" text", Style::default().add_modifier(Modifier::BOLD)),
]);

line.reset_style();
assert_eq!(Style::reset(), line.spans[0].style);
assert_eq!(Style::reset(), line.spans[1].style);

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

Sets the target alignment for this line of text. Defaults to: None, meaning the alignment is determined by the rendering widget.

Examples

let mut line = Line::from("Hi, what's up?");
assert_eq!(None, line.alignment);
assert_eq!(Some(Alignment::Right), line.alignment(Alignment::Right).alignment)

Trait Implementations

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

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

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

Returns the “default value” for a type.

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 String

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

Converts to this type from the input type.

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

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

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

fn from(value: Spans<'a>) -> Self

Converts to this type from the input type.

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

fn from(s: String) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'a> PartialEq<Line<'a>> for Line<'a>

fn eq(&self, other: &Line<'a>) -> 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<'a> Eq for Line<'a>

impl<'a> StructuralEq for Line<'a>

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