Enum RemainingError 

pub enum RemainingError {
    FileNotFound {
        path: PathBuf,
    },
    SymbolNotFound {
        symbol: String,
        file: PathBuf,
    },
    ParseError {
        file: PathBuf,
        message: String,
    },
    InvalidArgument {
        message: String,
    },
    FileTooLarge {
        path: PathBuf,
        bytes: u64,
    },
    PathTraversal {
        path: PathBuf,
    },
    UnsupportedLanguage {
        language: String,
    },
    AnalysisError {
        message: String,
    },
    FindingsDetected {
        count: u32,
    },
    AutodetectUnsupported {
        message: String,
    },
    Timeout {
        seconds: u64,
    },
    Io(Error),
    Json(Error),
}

Errors for remaining commands.

Variants

FileNotFound

File not found.

Fields

path: PathBuf

SymbolNotFound

Function/symbol not found.

Fields

symbol: String

file: PathBuf

ParseError

Parse error.

Fields

file: PathBuf

message: String

InvalidArgument

Invalid arguments.

Fields

message: String

FileTooLarge

File too large.

Fields

path: PathBuf

bytes: u64

PathTraversal

Path traversal blocked.

Fields

path: PathBuf

UnsupportedLanguage

Unsupported language.

Fields

language: String

AnalysisError

Analysis error.

Fields

message: String

FindingsDetected

Findings detected (for vuln/api-check - special exit code).

Fields

count: u32

AutodetectUnsupported

Autodetected language is not in the command’s supported set.

Distinct from Self::UnsupportedLanguage: that variant fires on --lang <L> explicitly passed where the command cannot handle L. This variant fires when no --lang was given, the autodetector identified L, and L is outside the command’s supported set. Emitted with exit code 2 so tooling can distinguish “analysis not attempted” from “analysis attempted and failed” (exit 1).

Fields

message: String

Timeout

Timeout.

Fields

seconds: u64

Io(Error)

IO error.

Json(Error)

JSON error.

Implementations

impl RemainingError

pub fn file_not_found(path: impl Into<PathBuf>) -> Self

Create a FileNotFound error

pub fn symbol_not_found( symbol: impl Into<String>, file: impl Into<PathBuf>, ) -> Self

Create a SymbolNotFound error

pub fn parse_error(file: impl Into<PathBuf>, message: impl Into<String>) -> Self

Create a ParseError

pub fn invalid_argument(message: impl Into<String>) -> Self

Create an InvalidArgument error

pub fn file_too_large(path: impl Into<PathBuf>, bytes: u64) -> Self

Create a FileTooLarge error

pub fn path_traversal(path: impl Into<PathBuf>) -> Self

Create a PathTraversal error

pub fn unsupported_language(language: impl Into<String>) -> Self

Create an UnsupportedLanguage error

pub fn analysis_error(message: impl Into<String>) -> Self

Create an AnalysisError

pub fn findings_detected(count: u32) -> Self

Create a FindingsDetected error

pub fn autodetect_unsupported(message: impl Into<String>) -> Self

Create an AutodetectUnsupported error with a full user-facing message. The message must describe the detected language and point the user at explicit --lang flags they can pass.

pub fn timeout(seconds: u64) -> Self

Create a Timeout error

pub fn exit_code(&self) -> i32

Get the appropriate exit code for this error

Trait Implementations

impl Debug for RemainingError

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

Formats the value using the given formatter.

impl Display for RemainingError

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

Formats the value using the given formatter.

impl Error for RemainingError

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 RemainingError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for RemainingError

fn from(source: Error) -> Self

Converts to this type from the input type.