Struct DocumentRun 

pub struct DocumentRun<'a> { /* private fields */ }

A document run with path roles made explicit.

config_path is a logical identity used by per-file configuration. A separate source_file is exposed to rules that may access the filesystem. Native adapters usually set both; browser and other virtual adapters set only config_path.

Implementations

impl<'a> DocumentRun<'a>

pub fn new( content: &'a str, rules: &'a [Box<dyn Rule>], config: &'a Config, ) -> Self

pub fn file_path(self, path: &'a Path) -> Self

Set a real file path for both per-file configuration and rule filesystem access.

pub fn config_path(self, path: Option<&'a Path>) -> Self

Set a logical path used only for per-file configuration matching.

pub fn source_file(self, path: Option<&'a Path>) -> Self

Set the filesystem path visible to rules independently of configuration matching.

pub fn verbose(self, verbose: bool) -> Self

pub fn flavor(&self) -> MarkdownFlavor

pub fn analyze(&self) -> Result<DocumentAnalysis, LintError>

pub fn analyze_raw(&self) -> (Result<Vec<LintWarning>, LintError>, FileIndex)

pub fn fix(&self, max_iterations: usize) -> Result<(String, FixResult), String>

pub fn config_path_buf(&self) -> Option<PathBuf>