Struct ratatui::text::Spans

pub struct Spans<'a>(pub Vec<Span<'a>>);

👎Deprecated: Use ratatui::text::Line instead

A string composed of clusters of graphemes, each with their own style.

Spans has been deprecated in favor of Line, and will be removed in the future. All methods that accept Spans have been replaced with methods that accept Into<Line<’a>> (which is implemented on Spans) to allow users of this crate to gradually transition to Line.

Tuple Fields

0: Vec<Span<'a>>

👎Deprecated: Use ratatui::text::Line instead

Implementations

impl<'a> Spans<'a>

pub fn width(&self) -> usize

Returns the width of the underlying string.

Examples

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

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

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

Examples

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

assert_ne!(raw_spans, styled_spans);

raw_spans.patch_style(style);
assert_eq!(raw_spans, styled_spans);

pub fn reset_style(&mut self)

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

Examples

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

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

pub fn alignment(self, alignment: Alignment) -> Line<'a>

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 = Spans::from("Hi, what's up?").alignment(Alignment::Right);
assert_eq!(Some(Alignment::Right), line.alignment)

Trait Implementations

impl<'a> Clone for Spans<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Spans<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Spans<'a>

fn default() -> Spans<'a>

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

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

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

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

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

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 Spans<'a>

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'a> PartialEq<Spans<'a>> for Spans<'a>

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

impl<'a> StructuralEq for Spans<'a>

impl<'a> StructuralPartialEq for Spans<'a>