retroglyph-core 0.6.0

A 2D pseudographic terminal library -- core types, no backend
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

//! Text layout: measurement, word wrapping, and bounded alignment.
//!
//! [`HAlign`](crate::layout::HAlign) and [`VAlign`](crate::layout::VAlign) are plain data (no allocation, no text handling) and are always
//! available regardless of the `egc` feature; [`Surface::print_aligned`](crate::surface::Surface::print_aligned)
//! uses them directly. [`crate::text::Span`] and [`crate::text::Line`] provide styled text
//! primitives, and [`TextLayout`](crate::layout::TextLayout) is a builder that word-wraps a [`crate::text::Line`] to a
//! bounded [`Rect`](crate::grid::Rect), then positions it with independent horizontal
//! ([`HAlign`](crate::layout::HAlign)) and vertical ([`VAlign`](crate::layout::VAlign)) alignment. Measure the result before rendering with
//! [`TextLayout::measure`](crate::layout::TextLayout::measure). [`wrap`] exposes that same word-wrap pass standalone, for callers
//! that need the broken-apart [`crate::text::Line`]s rather than a rendered surface.
//!
//! [`TextLayout`](crate::layout::TextLayout) and [`wrap`] are only available when the `egc` feature is enabled (requires
//! `alloc`): both call into `unicode-segmentation`/`unicode-width` directly, with no non-`egc`
//! fallback path.

mod align;
#[cfg(feature = "egc")]
mod text_layout;
#[cfg(feature = "egc")]
mod word_wrap;

pub use align::{HAlign, VAlign};
#[cfg(feature = "egc")]
pub use text_layout::TextLayout;
#[cfg(feature = "egc")]
pub use word_wrap::wrap;