Struct VersionValidator 

pub struct VersionValidator { /* private fields */ }

Available on crate feature doc-audit only.

Version validator that checks consistency between documentation and workspace.

Implementations

impl VersionValidator

pub async fn new(workspace_path: &Path) -> Result<VersionValidator, AuditError>

Creates a new version validator for the given workspace.

Arguments

• workspace_path - Path to the workspace root directory

Returns

A new VersionValidator instance or an error if workspace analysis fails.

pub fn with_workspace_info( workspace_info: WorkspaceVersionInfo, ) -> Result<VersionValidator, AuditError>

Creates a version validator with custom workspace information.

This is useful for testing or when workspace information is already available.

pub fn validate_version_reference( &self, version_ref: &VersionReference, config: &VersionValidationConfig, ) -> Result<VersionValidationResult, AuditError>

Validates a version reference against workspace information.

Arguments

• version_ref - The version reference to validate
• config - Validation configuration options

Returns

A VersionValidationResult indicating whether the reference is valid.

pub fn validate_version_references( &self, version_refs: &[VersionReference], config: &VersionValidationConfig, ) -> Result<Vec<VersionValidationResult>, AuditError>

Validates multiple version references in batch.

Arguments

• version_refs - Collection of version references to validate
• config - Validation configuration options

Returns

A vector of validation results corresponding to each input reference.

pub fn validate_dependency_compatibility( &self, dependency_name: &str, documented_version: &str, config: &VersionValidationConfig, ) -> Result<VersionValidationResult, AuditError>

Validates dependency version compatibility across the workspace.

This method checks that all dependency versions used in documentation are compatible with the versions actually used in the workspace.

pub fn is_version_compatible( &self, version1: &str, version2: &str, tolerance: &VersionTolerance, ) -> Result<bool, AuditError>

Checks if a version string represents a compatible version.

This method uses semantic versioning rules to determine compatibility.

pub fn validate_crate_exists(&self, crate_name: &str) -> VersionValidationResult

Validates that mentioned crate names exist in the workspace.

Arguments

• crate_name - Name of the crate to validate

Returns

A VersionValidationResult indicating whether the crate exists.

pub fn validate_feature_flag( &self, crate_name: &str, feature_name: &str, ) -> VersionValidationResult

Validates that feature flags exist in the specified crate.

Arguments

• crate_name - Name of the crate that should define the feature
• feature_name - Name of the feature flag to validate

Returns

A VersionValidationResult indicating whether the feature exists.

pub fn validate_crate_names( &self, crate_names: &[String], ) -> Vec<VersionValidationResult>

Validates multiple crate names in batch.

Arguments

• crate_names - Collection of crate names to validate

Returns

A vector of validation results corresponding to each input crate name.

pub fn validate_feature_mentions( &self, feature_mentions: &[FeatureMention], ) -> Vec<VersionValidationResult>

Validates feature flag references from documentation.

This method processes feature mentions extracted from documentation and validates them against the workspace feature definitions.

pub fn validate_feature_in_any_crate( &self, feature_name: &str, ) -> VersionValidationResult

Validates that a feature exists in any workspace crate.

This is used when the crate name cannot be determined from context.

pub fn get_workspace_crates(&self) -> Vec<String>

Gets all crate names in the workspace.

pub fn get_crate_features(&self, crate_name: &str) -> Option<Vec<String>>

Gets all features defined in a specific crate.

pub fn get_all_workspace_features(&self) -> HashMap<String, Vec<String>>

Gets all features defined across the workspace.

pub fn suggest_correct_version( &self, version_ref: &VersionReference, ) -> Option<String>

Suggests the correct version for an invalid reference.

This method provides intelligent suggestions based on the type of version reference and available workspace information.

Trait Implementations

impl Debug for VersionValidator

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

Formats the value using the given formatter.