Enum CleanLibraryError 

#[non_exhaustive]
pub enum CleanLibraryError {
    Config(ConfigError),
    PolicyDeny {
        reason_code: String,
        message: String,
    },
    IntegrityFailure {
        reason_code: String,
        message: String,
    },
    RateLimitExceeded {
        retry_after_seconds: u64,
        message: String,
    },
    RiskAcceptanceRequired {
        reason_code: String,
        message: String,
        guidance: Option<String>,
        docs_url: Option<String>,
    },
    Authentication {
        reason_code: String,
        message: String,
    },
    InsufficientData {
        reason_code: String,
        message: String,
    },
    CoverageIncomplete {
        reason_code: String,
        message: String,
    },
    AttestationInvalid {
        reason_code: String,
        message: String,
    },
    PackageNotFound(String),
    ServerError {
        status: u16,
        message: String,
        retryable: bool,
    },
    Problem {
        problem: ProblemDetails,
    },
    Transport(TransportError),
    Parse(String),
}

Top-level error type for cleanlib-client operations. Mirrors Rev 1 §2.3 mapping table.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Config(ConfigError)

PolicyDeny

Policy DENY — 403 + POLICY_DENY_VERDICT / POLICY_DENY_RULE_EXPLICIT, or 451 Unavailable For Legal Reasons (npm ecosystem alias).

Fields

reason_code: String

message: String

IntegrityFailure

403 + INTEGRITY_FAILURE — package hash mismatch on serve path (security incident; App refuses serve).

Fields

reason_code: String

message: String

RateLimitExceeded

429 Too Many Requests + Retry-After header.

Fields

retry_after_seconds: u64

message: String

RiskAcceptanceRequired

403 + RISK_ACCEPTANCE_REQUIRED — policy permits ALLOW but customer hasn’t signed risk-acceptance for this package/version. Customer should emit a rule via cleanlib risk-accept and upload to CDP admin UI.

Fields

reason_code: String

message: String

guidance: Option<String>

docs_url: Option<String>

Authentication

401 or 403 + KEY_INVALID / KEY_EXPIRED / KEY_SCOPE_INSUFFICIENT.

Fields

reason_code: String

message: String

InsufficientData

403 + INSUFFICIENT_DATA_FAIL_CLOSED — verdict unavailable + customer policy fails closed on missing data.

Fields

reason_code: String

message: String

CoverageIncomplete

CLEANLIB-657 (CX-8): a scan/fix run could not evaluate one or more coordinates (outage / TLS / 5xx / unreachable). NOT a verdict — the gate did not fully run; callers must never read this as clean coverage.

Fields

reason_code: String

message: String

AttestationInvalid

CLEANLIB-657 (CX-8): a signed attestation was present but failed verification (signature / key / canonical-form mismatch).

Fields

reason_code: String

message: String

PackageNotFound(String)

404 Not Found — package not in catalog + ingest declined or unavailable.

ServerError

5xx — server error. retryable=true for 502/503/504.

Fields

status: u16

message: String

retryable: bool

Problem

CLEANLIB-536: an RFC 9457 application/problem+json structured error. Carries the App’s problem document — the standard type/title/status/detail/instance members plus the CLEANLIB-536 extensions reason_class (the machine-stable branch key — not_ingested / dependency_degraded / permanently_blocked / service_unavailable), retryable, selfHealing, and resolution. Consumers branch on problem.reason_class and honor problem.retryable rather than scraping status codes or the raw body. Emitted when the App response is application/problem+json; legacy header/status responses keep the variants above.

Fields

problem: ProblemDetails

Transport(TransportError)

Network / TLS / timeout / DNS — pre-response transport-layer failure.

Parse(String)

Response body parse failure (malformed JSON, schema mismatch).

Implementations

impl CleanLibraryError

pub fn is_retryable(&self) -> bool

True if a transient retry could plausibly succeed. Callers may use this to gate retry/backoff logic. Per Rev 1 §2.3 + App Rev 4 §9.2.

pub fn reason_code(&self) -> Option<&str>

Reason code from App’s X-CleanLibrary-Reason header, if any.

Trait Implementations

impl Debug for CleanLibraryError

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

Formats the value using the given formatter.

impl Display for CleanLibraryError

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

Formats the value using the given formatter.

impl Error for CleanLibraryError

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<CleanLibraryError> for GateError

fn from(source: CleanLibraryError) -> Self

Converts to this type from the input type.

impl From<ConfigError> for CleanLibraryError

fn from(source: ConfigError) -> Self

Converts to this type from the input type.

impl From<TransportError> for CleanLibraryError

fn from(source: TransportError) -> Self

Converts to this type from the input type.