Struct MarkdownEngine 

pub struct MarkdownEngine { /* private fields */ }

The core indexing engine that transforms Markdown text into a Virtual File System. It uses a BTreeMap to maintain an ordered, searchable index of all sections.

Implementations

impl MarkdownEngine

pub fn new(content: &str) -> MarkdownEngine

Parses the provided Markdown content and builds a hierarchical Virtual File System index.

pub fn ls(&self, path: &str, page: usize, size: usize) -> PaginatedResult

Lists direct sub-sections for a given hierarchical path with pagination support. Use an empty path (“”) to retrieve root-level headings.

pub fn get_title(&self, path: &str) -> Option<String>

Retrieves the human-readable title of the section at the specified path.

pub fn read(&self, path: &str) -> Option<String>

Reads the direct text content of a section (non-recursive).

pub fn read_full(&self, path: &str) -> Option<String>

Reads the full content of a section, including all its sub-sections recursively.

pub fn get_reference(&self, ref_id: &str) -> Option<String>

Resolves a Markdown reference ID to its corresponding URL.

pub fn search(&self, query: &str) -> Vec<String>

Performs a case-insensitive search across all section titles. Returns a list of all matching hierarchical paths.