Struct PreparedMarkdown 

pub struct PreparedMarkdown { /* private fields */ }

A Markdown source with its micro tokens swapped for stand-in cells, ready for a Markdown renderer; view turns the stand-ins in its output into placeholders.

Markdown has no place for a tag, so each token becomes as many copies of one private-use character as the asset has columns (one cell each), and the layout sizes it as the asset. Tokens in code (blocks and inline spans) and in URLs (link and image destinations, autolinks, reference definitions) stay as written; so does \:micro:, whose backslash Markdown drops itself. Link text expands.

Markdown’s layout (quotes, lists, tables) is core’s, with no room for a row below a line, so an asset two rows high shows its first row: its fallback, never an image over the line below.

use rich::markdown::Markdown;
use rich_micro::{FallbackPreference, Layer, MicroAsset, MicroRegistry, PreparedMarkdown};

let mut registry = MicroRegistry::new();
registry.add(Layer::Inline, MicroAsset::new("ship", "rocket")?.with_emoji("🚀")?)?;
let prepared = PreparedMarkdown::new(
    "Go :micro:ship: `:micro:ship:`",
    &registry,
    FallbackPreference::Emoji,
);
let console = rich::Console::builder().width(40).build();
let shown = console.render_export(&prepared.view(Markdown::new(prepared.source())));
assert!(shown.starts_with("Go 🚀 "), "{shown:?}");
assert!(shown.contains(":micro:ship:"), "{shown:?}");

Implementations

impl PreparedMarkdown

pub fn new( source: &str, registry: &MicroRegistry, preference: FallbackPreference, ) -> Self

pub fn source(&self) -> &str

The Markdown to render.

pub fn has_assets(&self) -> bool

Whether any token was swapped.

pub fn diagnostics(&self) -> &[Diagnostic]

What was left as written.

pub fn view<R: Renderable>(&self, inner: R) -> MarkdownView<R>

inner (a renderer of source) with each run of stand-ins drawn as its asset’s placeholder cells, tagged, so a MicroView can draw it. A run the layout cut (wrapped or cropped) shows blank cells.

Trait Implementations

impl Clone for PreparedMarkdown

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PreparedMarkdown

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

Formats the value using the given formatter.