mant-engine 0.9.0

Structured manual and Markdown document engine used by ManT
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

#![doc = include_str!("../README.md")]
#![warn(missing_docs)]

mod bounded;
mod catalog;
mod definitions;
mod executable;
mod inline;
mod mandoc;
mod manual;
mod manual_paths;
mod markdown;
mod markdown_mapping;
mod output;
mod projection;
mod query;
mod scope;
mod search;
mod source;
mod text_safety;
mod tldr;

pub use catalog::{
    AvailableDocument, AvailableDocumentKind, AvailableDocumentOrigin, CatalogError,
    discover_documents, list_available_documents, query_available_documents,
};
pub use executable::find_host_executable;
pub use mandoc::{
    MAX_MANUAL_BYTES, ManualError, ManualErrorKind, lower_mandoc_document, parse_manual_bytes,
    parse_manual_page, parse_manual_source,
};
pub use mant_ir::ResolvedContent;
pub use manual::{is_command_manual_section, is_manual_section, parenthesized_manual_reference};
pub use manual_paths::discover_manual_roots;
pub use markdown::{MarkdownParseError, ParsedMarkdown, TldrDirectiveError, parse_markdown};
pub use output::{
    MarkdownOptions, SearchTextRole, render_excerpt_json, render_excerpt_markdown,
    render_excerpt_markdown_with_options, render_excerpt_text, render_markdown,
    render_markdown_with_options, render_outline_json, render_outline_markdown,
    render_outline_text, render_query_json, render_query_man, render_query_text,
    render_search_json, render_search_markdown, render_search_text, render_search_text_with,
    render_update_json,
};
pub use projection::{
    ProjectionError, SelectorCandidate, build_outline, build_outline_with_detail, select_excerpt,
    select_explanation,
};
pub use query::{
    DocumentResolver, MAX_MARKDOWN_BYTES, ManualLoadError, QueryError, QueryExecutionError,
    QueryPolicy, QueryViewResult, execute_query, project_query_view, query_markdown_text,
    query_roff_bytes, resolve_query, resolve_query_with_policy, validate_query_request,
};
pub use scope::{LoadedDocumentScope, ScopeQueryError, validate_scope_query_request};
pub use search::{SearchError, search_query, validate_search_query};
pub use source::{LocateError, ManualIndex, ManualPage, ManualRequest, locate_manual_source_in};
pub use tldr::{
    HostPlatform, TldrCacheError, TldrPageLocation, TldrParseError, get_system_tldr_cache_dirs,
    get_tldr_cache_dir, get_tldr_languages, get_tldr_platforms, get_tldr_read_cache_dirs,
    normalize_tldr_topic, parse_tldr_command, parse_tldr_page, read_cached_tldr_page,
};
#[cfg(feature = "tldr-update")]
pub use tldr::{TldrUpdateError, update_tldr_cache};

/// Reports the native contract version through the engine layer.
#[must_use]
pub const fn native_api_version() -> &'static str {
    mant_protocol::NATIVE_API_VERSION
}

#[cfg(test)]
mod tests {
    use super::native_api_version;

    #[test]
    fn exposes_the_native_api_version() {
        assert_eq!(native_api_version(), "0.9");
    }
}