hyperlit-runtime 0.1.0

A software documentation tool documentation embedded in source files - runtime crate
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

use crate::evaluate_directive::evaluate_directive;
use hyperlit_backend::backend::BackendCompileParams;
use hyperlit_base::result::HyperlitResult;
use hyperlit_model::database::Database;
use hyperlit_model::directive_evaluation::DirectiveEvaluation;
use hyperlit_model::segment::SegmentId;
use std::path::Path;

pub struct BackendCompileParamsImpl<'a> {
    docs_directory: &'a Path,
    build_directory: &'a Path,
    output_directory: &'a Path,
    database: &'a mut dyn Database,
}

impl<'a> BackendCompileParamsImpl<'a> {
    pub fn new(
        docs_directory: &'a Path,
        build_directory: &'a Path,
        output_directory: &'a Path,
        database: &'a mut dyn Database,
    ) -> Self {
        Self {
            docs_directory,
            build_directory,
            output_directory,
            database,
        }
    }
}

impl BackendCompileParams for BackendCompileParamsImpl<'_> {
    fn docs_directory(&self) -> &Path {
        self.docs_directory
    }

    fn build_directory(&self) -> &Path {
        self.build_directory
    }

    fn output_directory(&self) -> &Path {
        self.output_directory
    }

    fn evaluate_directive(&self, directive: &str) -> HyperlitResult<DirectiveEvaluation> {
        evaluate_directive(directive, self.database)
    }

    fn set_segment_included(&mut self, segment_id: SegmentId) -> HyperlitResult<()> {
        self.database.set_segment_included(segment_id)
    }
}