Skip to main content

RenderedBlock

Struct RenderedBlock 

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

A rectangular character grid with dimensional metadata.

This is the core data structure for 2D math rendering. Each cell contains a string (to handle multi-codepoint grapheme clusters). The baseline marks the row used for horizontal alignment when composing blocks side-by-side.

Implementations§

Source§

impl RenderedBlock

Source

pub fn new(cells: Vec<Vec<String>>, baseline: usize) -> Self

Create a new block from rows of cell strings.

Width is computed from the first row (all rows must have equal width). The baseline defaults to height / 2 if not specified.

Source

pub fn from_char(ch: char) -> Self

Create a block containing a single character.

Source

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

Create a block from a string of text (single row).

Source

pub fn empty() -> Self

Create an empty block with zero dimensions.

Source

pub fn width(&self) -> usize

Source

pub fn height(&self) -> usize

Source

pub fn baseline(&self) -> usize

Source

pub fn cells(&self) -> &[Vec<String>]

Source

pub fn is_empty(&self) -> bool

Source

pub fn beside(&self, other: &RenderedBlock) -> RenderedBlock

Place two blocks side-by-side, aligned on baselines. Pads the shorter block with empty rows above/below as needed.

Source

pub fn above( top: &RenderedBlock, bottom: &RenderedBlock, baseline_row: usize, ) -> RenderedBlock

Stack two blocks vertically. The baseline is set to baseline_row (typically the dividing row between them, or top/bottom block’s baseline).

Source

pub fn pad( &self, left: usize, right: usize, top: usize, bottom: usize, ) -> RenderedBlock

Add empty space around a block.

Source

pub fn center_in(&self, target_width: usize) -> RenderedBlock

Horizontally centre a block within a given width.

Source

pub fn hline(ch: char, width: usize) -> RenderedBlock

Create a horizontal line of a given character and width.

Trait Implementations§

Source§

impl Clone for RenderedBlock

Source§

fn clone(&self) -> RenderedBlock

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 Debug for RenderedBlock

Source§

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

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

impl Display for RenderedBlock

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.