Struct TextLayout 

pub struct TextLayout<'a> {
    line: &'a Line,
    rect: Rect,
    h_align: HAlign,
    v_align: VAlign,
}

Builder for laying out a Line within a bounded Rect.

Call measure to get TextMetrics without touching any terminal, or render to write directly into a Terminal.

Example

use retroglyph::layout::{TextLayout, HAlign, VAlign};
use retroglyph::grid::Rect;
use retroglyph::text::Line;

let rect = Rect::new(0, 0, 20, 5);
let line = Line::raw("Hello, world!");

let metrics = TextLayout::new(&line)
    .rect(rect)
    .h_align(HAlign::Center)
    .measure();

assert_eq!(metrics.height, 1);

Fields

line: &'a Line

rect: Rect

h_align: HAlign

v_align: VAlign

Implementations

impl<'a> TextLayout<'a>

pub const fn new(line: &'a Line) -> Self

Creates a new layout builder for line.

Defaults: zero-sized rect at origin, left/top alignment. Call rect before measure or render.

pub const fn rect(self, rect: Rect) -> Self

Sets the bounding rectangle.

pub const fn h_align(self, align: HAlign) -> Self

Sets the horizontal alignment.

pub const fn v_align(self, align: VAlign) -> Self

Sets the vertical alignment.

pub fn measure(&self) -> TextMetrics

Measures the text without rendering, returning its TextMetrics.

Uses the rect’s width for word-wrapping; ignores height.

pub fn render<B: Backend>(&self, terminal: &mut Terminal<B>)

Renders the text into terminal, clipping to the rect’s bounds.