mant_engine/
lib.rs

1#![doc = include_str!("../README.md")]
2#![warn(missing_docs)]
3
4mod bounded;
5mod catalog;
6mod definitions;
7mod executable;
8mod inline;
9mod mandoc;
10mod markdown;
11mod output;
12mod projection;
13mod query;
14mod search;
15mod source;
16mod text_safety;
17mod tldr;
18
19pub use catalog::{
20    AvailableDocument, AvailableDocumentKind, AvailableDocumentOrigin, CatalogError,
21    discover_documents, list_available_documents, query_available_documents,
22};
23pub use mandoc::{
24    MAX_MANUAL_BYTES, ManualError, ManualErrorKind, lower_mandoc_document, parse_manual_bytes,
25    parse_manual_page, parse_manual_source,
26};
27pub use mant_ir::ResolvedContent;
28pub use markdown::{MarkdownParseError, ParsedMarkdown, TldrDirectiveError, parse_markdown};
29pub use output::{
30    MarkdownOptions, render_excerpt_json, render_excerpt_markdown,
31    render_excerpt_markdown_with_options, render_excerpt_text, render_markdown,
32    render_markdown_with_options, render_outline_json, render_outline_markdown,
33    render_outline_text, render_query_json, render_query_man, render_query_text,
34    render_search_json, render_search_markdown, render_search_text, render_update_json,
35};
36pub use projection::{
37    ProjectionError, SelectorCandidate, build_outline, build_outline_with_detail, select_excerpt,
38    select_explanation,
39};
40pub use query::{
41    DocumentResolver, MAX_MARKDOWN_BYTES, ManualLoadError, QueryError, QueryExecutionError,
42    QueryPolicy, QueryViewResult, execute_query, project_query_view, query_markdown_text,
43    query_roff_bytes, resolve_query, resolve_query_with_policy, validate_query_request,
44};
45pub use search::{SearchError, search_query, validate_search_query};
46pub use source::{
47    LocateError, ManualIndex, ManualPage, ManualRequest, discover_manual_roots,
48    locate_manual_source_in,
49};
50pub use tldr::{
51    HostPlatform, TldrCacheError, TldrPageLocation, TldrParseError, TldrUpdateError,
52    get_system_tldr_cache_dirs, get_tldr_cache_dir, get_tldr_languages, get_tldr_platforms,
53    get_tldr_read_cache_dirs, normalize_tldr_topic, parse_tldr_command, parse_tldr_page,
54    read_cached_tldr_page, update_tldr_cache,
55};
56
57/// Reports the native contract version through the engine layer.
58#[must_use]
59pub const fn native_api_version() -> &'static str {
60    mant_protocol::NATIVE_API_VERSION
61}
62
63#[cfg(test)]
64mod tests {
65    use super::native_api_version;
66
67    #[test]
68    fn exposes_the_native_api_version() {
69        assert_eq!(native_api_version(), "7");
70    }
71}
mant_engine/lib.rs

mant_engine/
lib.rs
