Skip to main content

Line

Struct Line 

Source
pub struct Line<'a> { /* private fields */ }
Expand description

A single line of styled spans.

Implementations§

Source§

impl<'a> Line<'a>

Source

pub const fn new() -> Self

Create an empty line.

Source

pub fn from_spans(spans: impl IntoIterator<Item = Span<'a>>) -> Self

Create a line from spans.

Source

pub fn raw(content: impl Into<Cow<'a, str>>) -> Self

Create a line from a single raw string.

Source

pub fn styled(content: impl Into<Cow<'a, str>>, style: Style) -> Self

Create a line from a single styled string.

Source

pub fn is_empty(&self) -> bool

Check if the line is empty.

Source

pub fn len(&self) -> usize

Get the number of spans.

Source

pub fn width(&self) -> usize

Get the display width in cells.

Source

pub fn measurement(&self) -> TextMeasurement

Return bounds-based measurement for this line.

Source

pub fn spans(&self) -> &[Span<'a>]

Get the spans.

Source

pub fn push_span(&mut self, span: Span<'a>)

Add a span to the line.

Source

pub fn with_span(self, span: Span<'a>) -> Self

Append a span (builder pattern).

Source

pub fn apply_base_style(&mut self, base: Style)

Apply a base style to all spans.

The base style is merged with each span’s style, with the span’s style taking precedence for conflicting properties.

Source

pub fn to_plain_text(&self) -> String

Get the plain text content.

Source

pub fn wrap(&self, width: usize, mode: WrapMode) -> Vec<Line<'a>>

Wrap this line to the given width, preserving span styles.

Source

pub fn into_segments(self) -> Vec<Segment<'a>>

Convert to segments.

Source

pub fn into_segment_line(self) -> SegmentLine<'a>

Convert to a SegmentLine.

Source

pub fn iter(&self) -> impl Iterator<Item = &Span<'a>>

Iterate over spans.

Trait Implementations§

Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for Line<'a>

Source§

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

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

impl<'a> Default for Line<'a>

Source§

fn default() -> Line<'a>

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

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

impl From<String> for Line<'static>

Source§

fn from(s: String) -> Self

Converts to this type from the input type.
Source§

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

Source§

fn from_iter<I: IntoIterator<Item = Line<'a>>>(iter: I) -> Self

Creates a value from an iterator. Read more
Source§

impl<'a> Hash for Line<'a>

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<'a> IntoIterator for &'a Line<'a>

Source§

type Item = &'a Span<'a>

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a, Span<'a>>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<'a> IntoIterator for Line<'a>

Source§

type Item = Span<'a>

The type of the elements being iterated over.
Source§

type IntoIter = IntoIter<Span<'a>>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

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

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<'a> Eq for Line<'a>

Source§

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

Auto Trait Implementations§

§

impl<'a> Freeze for Line<'a>

§

impl<'a> RefUnwindSafe for Line<'a>

§

impl<'a> Send for Line<'a>

§

impl<'a> Sync for Line<'a>

§

impl<'a> Unpin for Line<'a>

§

impl<'a> UnsafeUnpin for Line<'a>

§

impl<'a> UnwindSafe for Line<'a>

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more