Struct AnalysisScope 

pub struct AnalysisScope {
    pub analyzed_files: Vec<PathBuf>,
    pub skipped_files: Vec<SkippedFile>,
    pub exclusion_patterns: Vec<String>,
}

Scope of the analysis showing what was analyzed and what was skipped

Fields

analyzed_files: Vec<PathBuf>

Files that were analyzed

skipped_files: Vec<SkippedFile>

Files that were skipped

exclusion_patterns: Vec<String>

Patterns used for exclusion

Implementations

impl AnalysisScope

pub fn new() -> Self

Creates a new empty analysis scope

Returns

A new empty AnalysisScope instance

Examples

use rust_diff_analyzer::types::AnalysisScope;

let scope = AnalysisScope::new();
assert!(scope.analyzed_files.is_empty());

pub fn add_analyzed(&mut self, path: PathBuf)

Adds an analyzed file to the scope

Arguments

• path - Path to the analyzed file

Examples

use std::path::PathBuf;

use rust_diff_analyzer::types::AnalysisScope;

let mut scope = AnalysisScope::new();
scope.add_analyzed(PathBuf::from("src/lib.rs"));
assert_eq!(scope.analyzed_files.len(), 1);

pub fn add_skipped(&mut self, path: PathBuf, reason: ExclusionReason)

Adds a skipped file to the scope

Arguments

• path - Path to the skipped file
• reason - Reason for exclusion

Examples

use std::path::PathBuf;

use rust_diff_analyzer::types::{AnalysisScope, ExclusionReason};

let mut scope = AnalysisScope::new();
scope.add_skipped(
    PathBuf::from("tests/test.rs"),
    ExclusionReason::IgnorePattern("tests/".to_string()),
);
assert_eq!(scope.skipped_files.len(), 1);

pub fn set_patterns(&mut self, patterns: Vec<String>)

Sets the exclusion patterns

Arguments

• patterns - List of exclusion patterns

Examples

use rust_diff_analyzer::types::AnalysisScope;

let mut scope = AnalysisScope::new();
scope.set_patterns(vec!["tests/".to_string(), "benches/".to_string()]);
assert_eq!(scope.exclusion_patterns.len(), 2);

pub fn non_rust_count(&self) -> usize

Returns count of non-Rust files skipped

Returns

Number of non-Rust files

Examples

use std::path::PathBuf;

use rust_diff_analyzer::types::{AnalysisScope, ExclusionReason};

let mut scope = AnalysisScope::new();
scope.add_skipped(PathBuf::from("README.md"), ExclusionReason::NonRust);
scope.add_skipped(PathBuf::from("Cargo.toml"), ExclusionReason::NonRust);
assert_eq!(scope.non_rust_count(), 2);

pub fn ignored_count(&self) -> usize

Returns count of files skipped due to ignore patterns

Returns

Number of ignored files

Examples

use std::path::PathBuf;

use rust_diff_analyzer::types::{AnalysisScope, ExclusionReason};

let mut scope = AnalysisScope::new();
scope.add_skipped(
    PathBuf::from("tests/test.rs"),
    ExclusionReason::IgnorePattern("tests/".to_string()),
);
assert_eq!(scope.ignored_count(), 1);

Trait Implementations

impl Clone for AnalysisScope

fn clone(&self) -> AnalysisScope

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AnalysisScope

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

Formats the value using the given formatter.

impl Default for AnalysisScope

fn default() -> AnalysisScope

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AnalysisScope

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AnalysisScope

fn eq(&self, other: &AnalysisScope) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AnalysisScope

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AnalysisScope

impl StructuralPartialEq for AnalysisScope