Struct Document 

pub struct Document { /* private fields */ }

A parsed and rendered markdown document.

Implementations

impl Document

Parse markdown source into a Document.

Example

use markless::document::Document;

let doc = Document::parse("# Hello\n\nWorld").unwrap();
assert!(doc.line_count() >= 3); // heading + empty + paragraph + trailing empty

pub fn parse(source: &str) -> Result<Self>

Errors

Returns an error if markdown parsing fails.

pub fn parse_with_layout(source: &str, width: u16) -> Result<Self>

Errors

Returns an error if markdown parsing fails.

pub fn parse_with_image_heights( source: &str, image_heights: &HashMap<String, usize>, ) -> Result<Self>

Errors

Returns an error if markdown parsing fails.

pub fn parse_with_layout_and_image_heights( source: &str, width: u16, image_heights: &HashMap<String, usize>, ) -> Result<Self>

Errors

Returns an error if markdown parsing fails.

pub fn parse_with_mermaid_images(source: &str, width: u16) -> Result<Self>

Parse markdown, rendering mermaid code blocks as image placeholders.

Errors

Returns an error if markdown parsing fails.

pub fn parse_with_all_options( source: &str, width: u16, image_heights: &HashMap<String, usize>, mermaid_as_images: bool, ) -> Result<Self>

Parse with all options: layout width, image heights, and mermaid-as-images flag.

Errors

Returns an error if markdown parsing fails.

impl Document

pub fn empty() -> Self

Create an empty document.

pub fn from_plain_text(source: &str) -> Self

Create a document from plain text, rendering each line verbatim.

Used for non-markdown files where line breaks should be preserved exactly as they appear in the source.

pub fn from_hex(file_name: &str, bytes: Vec<u8>) -> Self

Create a hex document from raw bytes.

Stores header lines (heading + size info) in self.lines and raw bytes in hex_data for lazy hex line generation on demand.

pub fn line_count(&self) -> usize

Get the total number of rendered lines.

pub const fn is_hex_mode(&self) -> bool

Returns true if this document uses lazy hex rendering.

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

Get all headings for TOC.

pub fn images(&self) -> &[ImageRef]

Get all image references.

pub fn links(&self) -> &[LinkRef]

Get all link references.

pub const fn mermaid_sources(&self) -> &HashMap<String, String>

Get mermaid diagram sources keyed by synthetic image src.

pub fn footnote_line(&self, name: &str) -> Option<usize>

pub fn resolve_internal_anchor(&self, anchor: &str) -> Option<usize>

pub fn visible_lines(&self, offset: usize, count: usize) -> Vec<&RenderedLine>

Get visible lines for rendering.

Returns lines from offset to offset + count.

pub fn line_at(&self, index: usize) -> Option<&RenderedLine>

Get a specific rendered line by index.

pub fn source(&self) -> &str

Get the source text.

pub fn hex_line_content(&self, index: usize) -> Option<String>

Generate the text content for a hex line at the given document index.

Returns the header line content for header indices, or generates the hex dump line on the fly for hex indices. Returns None if out of range. Unlike line_at, this does not require the cache to be populated.

pub fn ensure_hex_lines_for_range(&mut self, range: Range<usize>)

Ensure hex lines are cached for the given document line range.

Generates hex dump lines for the viewport plus a buffer on each side. The range is in terms of overall document line indices (including headers).

pub fn ensure_highlight_for_range(&mut self, range: Range<usize>)

Lazily apply syntax highlighting to code blocks intersecting range.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.