Struct DocumentationParser 

pub struct DocumentationParser { /* private fields */ }

Available on crate feature doc-audit only.

Parser for documentation files that extracts validation-relevant content.

Implementations

impl DocumentationParser

pub fn new( workspace_version: String, rust_version: String, ) -> Result<DocumentationParser, AuditError>

Creates a new documentation parser with the given workspace configuration.

Arguments

• workspace_version - Current version of the ADK-Rust workspace
• rust_version - Required Rust version for the workspace

Returns

A new DocumentationParser instance or an error if regex compilation fails.

pub async fn parse_file( &self, file_path: &Path, ) -> Result<ParsedDocument, AuditError>

Parses a markdown file and extracts all relevant content for validation.

Arguments

• file_path - Path to the markdown file to parse

Returns

A ParsedDocument containing all extracted content or an error if parsing fails.

pub fn parse_content( &self, file_path: &Path, content: &str, ) -> Result<ParsedDocument, AuditError>

Parses markdown content from a string.

Arguments

• file_path - Path to the file (for error reporting)
• content - Markdown content to parse

Returns

A ParsedDocument containing all extracted content.

pub fn extract_rust_examples( &self, content: &str, ) -> Result<Vec<CodeExample>, AuditError>

Extracts Rust code blocks specifically for compilation testing.

This method focuses on extracting Rust code examples that should be compilable, filtering out display-only examples and identifying runnable vs non-runnable code.

pub fn extract_configuration_examples( &self, content: &str, ) -> Result<Vec<CodeExample>, AuditError>

Extracts configuration examples from TOML code blocks.

This method specifically looks for Cargo.toml configuration examples and extracts feature flag and dependency information.

Trait Implementations

impl Debug for DocumentationParser

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.