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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

//! Application adapters validate complete requests before loading or querying.
use super::{
    DocumentLoader, LoadPolicy, LoadSpec, PreparedQueryRequest, QueryError, QueryExecutionError,
    QueryInput, QueryRequest, QueryViewResult, ResolvedContent, project_query_view,
};
use mant_protocol::{CatalogQuery, DocumentCatalog};

/// Application composition over an explicit local document snapshot.
pub struct DocumentResolver {
    loader: DocumentLoader,
}
impl DocumentResolver {
    /// Capture source discovery for related application operations.
    #[must_use]
    pub fn from_system() -> Self {
        Self {
            loader: DocumentLoader::from_system(),
        }
    }
    /// Validate the entire request before resolving its source.
    ///
    /// # Errors
    /// Returns loading or query-view validation errors.
    pub fn resolve(
        &self,
        request: &QueryRequest,
        policy: LoadPolicy,
    ) -> Result<ResolvedContent, QueryError> {
        PreparedQueryRequest::new(request, policy)?.resolve(self)
    }
    pub(super) fn resolve_validated(
        &self,
        request: &QueryRequest,
        policy: LoadPolicy,
    ) -> Result<ResolvedContent, QueryError> {
        self.loader
            .load(load_spec(&request.input), policy)
            .map_err(QueryError::Load)
    }
    /// Load and materialize the view encoded by a complete request.
    ///
    /// # Errors
    /// Returns loading, validation, projection or search failure.
    pub fn execute(
        &self,
        request: &QueryRequest,
        policy: LoadPolicy,
    ) -> Result<QueryViewResult, QueryExecutionError> {
        PreparedQueryRequest::new(request, policy)
            .map_err(QueryExecutionError::Query)?
            .execute(self)
    }
    pub(super) fn execute_validated(
        &self,
        request: &QueryRequest,
        policy: LoadPolicy,
    ) -> Result<QueryViewResult, QueryExecutionError> {
        let content = self
            .resolve_validated(request, policy)
            .map_err(QueryExecutionError::Query)?;
        project_query_view(content, &request.view)
    }
    /// Discover candidates from the same local snapshot.
    ///
    /// # Errors
    /// Returns source configuration or catalog filter failures.
    pub fn discover(&self, query: &CatalogQuery) -> Result<DocumentCatalog, String> {
        self.loader.discover(query)
    }

    /// Discover with a query prepared before this environment was captured.
    ///
    /// # Errors
    /// Returns source configuration or catalog acquisition failures.
    pub fn discover_prepared(
        &self,
        query: &mant_loader::PreparedCatalogQuery<'_>,
    ) -> Result<DocumentCatalog, String> {
        self.loader.discover_prepared(query)
    }
    pub(crate) fn loader(&self) -> &DocumentLoader {
        &self.loader
    }
}

pub(super) fn load_spec(input: &QueryInput) -> LoadSpec<'_> {
    match input {
        QueryInput::Document {
            selector,
            source,
            manual_section,
        } => LoadSpec::Document {
            selector,
            source: source.as_deref(),
            manual_section: manual_section.as_deref(),
        },
        QueryInput::File { path, format } => LoadSpec::File {
            path,
            format: *format,
        },
    }
}

#[cfg(test)]
pub(super) fn query_with(
    request: &QueryRequest,
    policy: LoadPolicy,
    load: impl FnOnce() -> Result<ResolvedContent, QueryError>,
) -> Result<ResolvedContent, QueryError> {
    PreparedQueryRequest::new(request, policy)?;
    load()
}