Trait BackendCompileParams 

pub trait BackendCompileParams {
    // Required methods
    fn docs_directory(&self) -> &Path;
    fn build_directory(&self) -> &Path;
    fn output_directory(&self) -> &Path;
    fn evaluate_directive(
        &self,
        tag: &str,
    ) -> HyperlitResult<DirectiveEvaluation<'_>>;
    fn set_segment_included(
        &mut self,
        segment_id: SegmentId,
    ) -> HyperlitResult<()>;
}

Parameters for the compilation process

Required Methods

fn docs_directory(&self) -> &Path

Path to the directory containing the documentation files

fn build_directory(&self) -> &Path

Path to the directory where the documentation will be built

fn output_directory(&self) -> &Path

Path to the directory where the documentation will be output

fn evaluate_directive( &self, tag: &str, ) -> HyperlitResult<DirectiveEvaluation<'_>>

Retrieve all segments containing the given tag

fn set_segment_included(&mut self, segment_id: SegmentId) -> HyperlitResult<()>

Mark a segment as included in the output

Implementors