Skip to main content

RenderResult

Struct RenderResult 

Source
pub struct RenderResult {
    pub lines: Vec<Vec<Segment>>,
    pub items: Vec<RenderItem>,
}
Expand description

The result of rendering: a list of lines, each line being a list of segments. Also carries an optional items list for recursive rendering.

Fields§

§lines: Vec<Vec<Segment>>

Flat line-oriented segments (backward-compatible).

§items: Vec<RenderItem>

Optional render items for recursive flattening. When present, Console::render() recurses into nested renderables.

Implementations§

Source§

impl RenderResult

Source

pub fn new() -> Self

Create an empty RenderResult.

Source

pub fn from_text(text: &str) -> Self

Create a RenderResult from a plain text string.

The text becomes a single line with one segment.

Source

pub fn from_segments(segments: Vec<Segment>) -> Self

Create a RenderResult from a list of Segments on a single line.

Source

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

Create a RenderResult from pre-computed lines of Segments.

Source

pub fn from_items(items: Vec<RenderItem>) -> Self

Create a RenderResult from RenderItems for recursive flattening.

Source

pub fn push_item(&mut self, item: impl Into<RenderItem>)

Push a segment item.

Source

pub fn push_renderable(&mut self, r: impl Renderable + Send + Sync + 'static)

Push a nested renderable for recursive flattening.

Source

pub fn flatten(&self, options: &ConsoleOptions) -> Vec<Segment>

Recursively flatten items into segments using the given options. This is called by Console::render() to resolve nested renderables.

Source

pub fn to_ansi(&self) -> String

Flatten all segments into a single ANSI string.

Trait Implementations§

Source§

impl Clone for RenderResult

Source§

fn clone(&self) -> RenderResult

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 RenderResult

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> 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 = 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.