Struct CodeAnalyzer 

pub struct CodeAnalyzer { /* private fields */ }

Available on crate feature doc-audit only.

Code analyzer for extracting API information from Rust workspace.

Implementations

impl CodeAnalyzer

pub fn new(workspace_path: PathBuf) -> CodeAnalyzer

Create a new code analyzer for the given workspace.

pub async fn analyze_workspace(&mut self) -> Result<&CrateRegistry, AuditError>

Analyze the entire workspace and build a registry of all crates and their APIs.

pub async fn get_registry(&mut self) -> Result<&CrateRegistry, AuditError>

Get the cached crate registry, analyzing the workspace if not already done.

pub async fn validate_api_reference( &mut self, api_ref: &ApiReference, ) -> Result<ValidationResult, AuditError>

Validate an API reference against the analyzed crates.

pub async fn find_undocumented_apis( &mut self, documented_apis: &[ApiReference], ) -> Result<Vec<PublicApi>, AuditError>

Find APIs that exist in the codebase but are not documented.

pub async fn validate_function_signature( &mut self, api_ref: &ApiReference, expected_signature: &str, ) -> Result<ValidationResult, AuditError>

Validate that a function signature matches the documented signature.

pub async fn validate_struct_fields( &mut self, api_ref: &ApiReference, expected_fields: &[String], ) -> Result<ValidationResult, AuditError>

Validate that struct fields mentioned in documentation exist.

pub async fn validate_import_statement( &mut self, import_path: &str, ) -> Result<ValidationResult, AuditError>

Validate that import statements are valid for the current crate structure.

pub async fn validate_method_exists( &mut self, type_ref: &ApiReference, method_name: &str, ) -> Result<ValidationResult, AuditError>

Validate that method names mentioned in documentation exist on the specified type.