Enum CodeLoreError 

pub enum CodeLoreError {
    Repo(String),
    Analysis(String),
    Output(String),
    Io(Error),
    RepoIo(Error),
    MalformedTeamMap {
        path: PathBuf,
        line: usize,
        reason: String,
    },
    UnknownAnalysisName {
        name: String,
        supported: Vec<&'static str>,
    },
    BlobNotFound {
        oid: String,
    },
    InvalidOptions(String),
}

Variants

Repo(String)

Analysis(String)

Output(String)

Io(Error)

RepoIo(Error)

std::io::Error from a read-side input path — loading a user-supplied config file (--team-map, --arch-rules-file), probing a repo path, reading a .gitignore chain. Distinct from Io (which covers write-side output emitter failures and auto-derives via #[from]) because the exit-code mapping differs: read-side input failures map to spec §6.6 exit 3 (repo/input error) so CI orchestrators can distinguish “the user pointed me at unreadable input” from “the output pipe broke mid-write”. Constructed explicitly at the small set of read-side call sites; never participates in From so generic ? propagation defaults to the write-side Io variant.

MalformedTeamMap

User-supplied team-map CSV is malformed. line is 1-indexed and 0 means a structural problem before any data row (e.g. missing header). CLI uses this to print a “fix <path> line N” hint.

Fields

path: PathBuf

line: usize

reason: String

UnknownAnalysisName

--analysis foo was passed but foo isn’t an analysis name we know. supported lists what we DO accept so the CLI can echo it.

Fields

name: String

supported: Vec<&'static str>

BlobNotFound

A blob OID resolved from a tree-walk wasn’t found in the object database. Almost always means the repo is shallow-cloned (parent ancestry truncated) or corrupted; distinct from generic repo errors so consumers can refuse to retry on bad data.

Fields

oid: String

InvalidOptions(String)

Cross-field validation of CLI options failed (e.g. --min-coupling exceeds --max-coupling, an out-of-range clone-similarity floor, or --after later than --before). A pure argument conflict, sharing the exit-2 configuration-error bucket with MalformedTeamMap.

Implementations

impl CodeLoreError

pub fn exit_code(&self) -> i32

CLI exit code for this error variant. See spec §6.6.

Trait Implementations

impl Debug for CodeLoreError

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

Formats the value using the given formatter.

impl Display for CodeLoreError

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

Formats the value using the given formatter.

impl Error for CodeLoreError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for CodeLoreError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<UnknownAnalysisError> for CodeLoreError

fn from(e: UnknownAnalysisError) -> Self

Converts to this type from the input type.