mant_core/
lib.rs

1//! Manual source, query, and output engine independent from its process hosts.
2
3mod definitions;
4mod groff_html;
5mod mandoc;
6mod markdown;
7mod output;
8mod projection;
9mod query;
10mod search;
11mod source;
12mod tldr;
13
14pub use groff_html::parse_groff_html;
15pub use mandoc::{lower_mandoc_document, parse_manual_source};
16pub use markdown::{MarkdownParseError, ParsedMarkdown, TldrDirectiveError, parse_markdown};
17pub use output::{
18    MarkdownOptions, render_excerpt_json, render_excerpt_markdown,
19    render_excerpt_markdown_with_options, render_excerpt_text, render_markdown,
20    render_markdown_with_options, render_outline_json, render_outline_markdown,
21    render_outline_text, render_query_json, render_query_man, render_query_text,
22    render_search_json, render_search_markdown, render_search_text, render_update_json,
23};
24pub use projection::{ProjectionError, build_outline, build_outline_with_detail, select_excerpt};
25pub use query::{
26    MAX_MARKDOWN_BYTES, QueryError, QueryPolicy, query, query_markdown_text, query_with_policy,
27};
28pub use search::{SearchError, search_query, validate_search_query};
29pub use source::{
30    CommandOutput, CommandRunner, LocateError, ManualRequest, SystemCommandRunner,
31    locate_manual_source, locate_manual_source_with,
32};
33pub use tldr::{
34    HostPlatform, TldrCacheError, TldrPageLocation, TldrParseError, TldrUpdateError,
35    get_system_tldr_cache_dirs, get_tldr_cache_dir, get_tldr_languages, get_tldr_platforms,
36    get_tldr_read_cache_dirs, normalize_tldr_topic, parse_tldr_command, parse_tldr_page,
37    read_cached_tldr_page, update_tldr_cache,
38};
39
40/// Reports the native contract version through the engine layer.
41#[must_use]
42pub const fn native_api_version() -> &'static str {
43    mant_ast::NATIVE_API_VERSION
44}
45
46#[cfg(test)]
47mod tests {
48    use super::native_api_version;
49
50    #[test]
51    fn exposes_the_ast_contract_version() {
52        assert_eq!(native_api_version(), "3");
53    }
54}
mant_core/lib.rs

mant_core/
lib.rs
