rustqual 1.2.0

Comprehensive Rust code quality analyzer — seven dimensions: IOSP, Complexity, DRY, SRP, Coupling, Test Quality, Architecture
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

//! Port: load source files from some root (filesystem, in-memory, etc.).

use crate::domain::SourceUnit;
use std::path::{Path, PathBuf};

/// Yields the set of source files a use-case should analyse.
///
/// Implementations must be thread-safe so analysers can parallelise over
/// the returned units via rayon.
pub trait SourceLoader: Send + Sync {
    /// Load all source files reachable from `root`.
    ///
    /// The meaning of `root` is up to the implementation: a directory path
    /// for the filesystem loader, a workspace descriptor for the
    /// workspace-aware loader, a fake root for tests.
    fn load(&self, root: &Path) -> Result<Vec<SourceUnit>, LoadError>;
}

/// Errors that a `SourceLoader` may report.
///
/// The variant set is kept small and semantic; library-specific errors
/// (e.g. `walkdir::Error`) stay inside the adapter implementing this port.
#[derive(Debug, thiserror::Error)]
pub enum LoadError {
    #[error("root not found: {0}")]
    RootNotFound(PathBuf),
    #[error("i/o error reading {path}: {message}")]
    Io { path: PathBuf, message: String },
    #[error("utf-8 decode error in {path}: {message}")]
    DecodeError { path: PathBuf, message: String },
    #[error("loader refused root: {0}")]
    Refused(String),
}