Skip to main content

Layout

Struct Layout 

Source
pub struct Layout { /* private fields */ }
Expand description

Prepared terminal rows and document-relative navigation positions.

A layout owns its rendered text and styles, so the source Document and LayoutOptions can be dropped after construction. Rendering never wraps or reparses it. Prepare a new layout when the content-area width changes.

Implementations§

Source§

impl Layout

Source

pub fn new( document: &Document, width: u16, options: &LayoutOptions, ) -> Result<Self, LayoutError>

Lays out a parsed document synchronously for width terminal cells.

Unicode grapheme clusters are measured by display width. Width zero produces an empty layout. A grapheme wider than the available content width becomes �; a wide grapheme is never split across cells.

§Errors

Returns LayoutError::TooManyLines before retaining more than the configured LayoutOptions::line_limit budget.

Source

pub fn width(&self) -> u16

Width in terminal cells for which this layout was prepared.

Source

pub fn line_count(&self) -> usize

Total row count after wrapping, including block spacing.

Returns document-relative link cells after wrapping.

Positions use the IDs assigned by markdown_model::Document::links. Widget offsets and scroll state are not included.

Source

pub fn headings(&self) -> &[HeadingPosition]

Returns heading anchors and their document-relative rows.

Source

pub fn plain_lines(&self) -> Vec<String>

Allocates the plain text of every prepared row.

This is useful for tests, export, and accessibility adapters. Render Layout::widget when styles are needed or the allocation is unwanted.

Source

pub fn widget(&self) -> MarkdownWidget<'_>

Borrows this layout as a MarkdownWidget.

Trait Implementations§

Source§

impl Clone for Layout

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 Layout

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.