mant-engine 0.11.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

//! Query execution boundary; public entry points remain validated.
use super::{
    QueryExecutionError, QueryView, QueryViewResult, ResolvedContent, SearchQuery, search_query,
    select_excerpt,
};

/// Materialize one view from an already loaded query.
///
/// # Errors
///
/// Returns a typed projection or search failure.
pub fn project_query_view(
    query: ResolvedContent,
    view: &QueryView,
) -> Result<QueryViewResult, QueryExecutionError> {
    validate_query_view(view)
        .map_err(|error| QueryExecutionError::Query(super::QueryError::QueryValidation(error)))?;
    match view {
        QueryView::Full {} => Ok(QueryViewResult::Full(Box::new(query))),
        QueryView::Outline {
            entries,
            root,
            references,
        } => {
            mant_query::build_outline_with_references(
                &query,
                entries.clone(),
                root.clone(),
                references,
            )
        }
        .map(QueryViewResult::Outline)
        .map_err(QueryExecutionError::Projection),
        QueryView::Excerpt { selectors } => select_excerpt(&query, selectors)
            .map(QueryViewResult::Excerpt)
            .map_err(QueryExecutionError::Projection),
        QueryView::Explain { entry, options } => mant_query::explain_query(
            &query,
            &mant_protocol::ExplanationQuery {
                entry: entry.clone(),
                options: *options,
            },
        )
        .map(QueryViewResult::Explanation)
        .map_err(|error| {
            QueryExecutionError::Query(super::QueryError::QueryValidation(
                super::QueryValidationError::InvalidExplanation(error),
            ))
        }),
        QueryView::Search {
            pattern,
            syntax,
            case,
            scope,
            word,
            context_lines,
            limit,
            offset,
        } => search_query(
            &query,
            &SearchQuery {
                pattern: pattern.clone(),
                syntax: *syntax,
                case: *case,
                scope: *scope,
                word: *word,
                context_lines: *context_lines,
                limit: *limit,
                offset: *offset,
            },
        )
        .map(QueryViewResult::Search)
        .map_err(QueryExecutionError::Search),
    }
}

use super::validation::validate_query_view;