Trait CompilationRule

pub trait CompilationRule:
    Send
    + Sync
    + Debug {
    // Required methods
    fn search_pattern(&self) -> &String;
    fn search_pattern_regex(&self) -> &Regex;
    fn standard_compile(
        &self,
        compilable: &CompilableText,
        format: &OutputFormat,
        compilation_configuration: &CompilationConfiguration,
        compilation_configuration_overlay: CompilationConfigurationOverLay,
    ) -> Result<CompilableText, CompilationError>;

    // Provided methods
    fn is_match(&self, content: &str) -> bool { ... }
    fn find_iter<'r, 'h>(&'r self, content: &'h str) -> Vec<Match<'h>> { ... }
    fn fast_compile(
        &self,
        compilable: &CompilableText,
        format: &OutputFormat,
        compilation_configuration: &CompilationConfiguration,
        compilation_configuration_overlay: CompilationConfigurationOverLay,
    ) -> Result<CompilableText, CompilationError> { ... }
    fn compile(
        &self,
        compilable: &CompilableText,
        format: &OutputFormat,
        compilation_configuration: &CompilationConfiguration,
        compilation_configuration_overlay: CompilationConfigurationOverLay,
    ) -> Result<CompilableText, CompilationError> { ... }
}

Required Methods

fn search_pattern(&self) -> &String

fn search_pattern_regex(&self) -> &Regex

fn standard_compile( &self, compilable: &CompilableText, format: &OutputFormat, compilation_configuration: &CompilationConfiguration, compilation_configuration_overlay: CompilationConfigurationOverLay, ) -> Result<CompilableText, CompilationError>

Compile string

Provided Methods

fn is_match(&self, content: &str) -> bool

fn find_iter<'r, 'h>(&'r self, content: &'h str) -> Vec<Match<'h>>

fn fast_compile( &self, compilable: &CompilableText, format: &OutputFormat, compilation_configuration: &CompilationConfiguration, compilation_configuration_overlay: CompilationConfigurationOverLay, ) -> Result<CompilableText, CompilationError>

Compile string avoid time consuming operations (incomplete compilation)

fn compile( &self, compilable: &CompilableText, format: &OutputFormat, compilation_configuration: &CompilationConfiguration, compilation_configuration_overlay: CompilationConfigurationOverLay, ) -> Result<CompilableText, CompilationError>

Standard or fast compilation based on CompilationConfiguration fast_draft()

Implementors

impl CompilationRule for HtmlCiteRule

impl CompilationRule for HtmlGreekLettersRule

impl CompilationRule for ReferenceRule

impl CompilationRule for ReplacementRule