Skip to main content

Line

Enum Line 

Source
pub enum Line {
    Str(String),
    Spans(Vec<Span>),
    Full {
        spans: Vec<Span>,
        style: Option<Style>,
        alignment: Option<Alignment>,
    },
}
Expand description

ratatui Line: a string, an array of spans, or {spans, style?, alignment?}.

Variants§

§

Str(String)

Shorthand: plain string.

§

Spans(Vec<Span>)

Shorthand: array of spans.

§

Full

Full form.

Fields

§spans: Vec<Span>

Line spans.

§style: Option<Style>

Line style.

§alignment: Option<Alignment>

Line alignment.

Implementations§

Source§

impl Line

Source

pub fn from_spans(spans: Vec<Span>) -> Self

Full-form line from spans.

Source

pub fn to_text(&self) -> String

Flattens the line to plain text.

Source

pub fn as_span(&self) -> Option<&Span>

A single-span line holding text (empty for shorthand string lines).

Source

pub fn spans(&self) -> Vec<Span>

The line’s spans (a shorthand string becomes one span).

Source

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

The line’s style, if any.

Source

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

The line’s alignment, if any.

Trait Implementations§

Source§

impl Clone for Line

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Line

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Line

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Line

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&str> for Line

Source§

fn from(s: &str) -> Self

Converts to this type from the input type.
Source§

impl From<Line> for Text

Source§

fn from(line: Line) -> Self

Converts to this type from the input type.
Source§

impl From<Line> for BlockTitle

Source§

fn from(line: Line) -> Self

Converts to this type from the input type.
Source§

impl From<Span> for Line

Source§

fn from(span: Span) -> Self

Converts to this type from the input type.
Source§

impl From<String> for Line

Source§

fn from(s: String) -> Self

Converts to this type from the input type.
Source§

impl From<Vec<Span>> for Line

Source§

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

Converts to this type from the input type.
Source§

impl PartialEq for Line

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Line

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Line

Source§

impl Stylize<Line> for Line

Source§

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

Applies a style.
Source§

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

Sets the foreground token.
Source§

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

Sets the background token.
Source§

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

Sets the underline colour token.
Source§

fn bold(self) -> T

Adds the BOLD modifier.
Source§

fn dim(self) -> T

Adds the DIM modifier.
Source§

fn italic(self) -> T

Adds the ITALIC modifier.
Source§

fn underlined(self) -> T

Adds the UNDERLINED modifier.
Adds the SLOW_BLINK modifier.
Adds the RAPID_BLINK modifier.
Source§

fn reversed(self) -> T

Adds the REVERSED modifier.
Source§

fn hidden(self) -> T

Adds the HIDDEN modifier.
Source§

fn crossed_out(self) -> T

Adds the CROSSED_OUT modifier.
Source§

impl Stylize<Line> for Vec<Span>

Source§

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

Applies a style.
Source§

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

Sets the foreground token.
Source§

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

Sets the background token.
Source§

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

Sets the underline colour token.
Source§

fn bold(self) -> T

Adds the BOLD modifier.
Source§

fn dim(self) -> T

Adds the DIM modifier.
Source§

fn italic(self) -> T

Adds the ITALIC modifier.
Source§

fn underlined(self) -> T

Adds the UNDERLINED modifier.
Adds the SLOW_BLINK modifier.
Adds the RAPID_BLINK modifier.
Source§

fn reversed(self) -> T

Adds the REVERSED modifier.
Source§

fn hidden(self) -> T

Adds the HIDDEN modifier.
Source§

fn crossed_out(self) -> T

Adds the CROSSED_OUT modifier.

Auto Trait Implementations§

§

impl Freeze for Line

§

impl RefUnwindSafe for Line

§

impl Send for Line

§

impl Sync for Line

§

impl Unpin for Line

§

impl UnsafeUnpin for Line

§

impl UnwindSafe for Line

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.