Enum FaucetError 

#[non_exhaustive]
pub enum FaucetError {
    Http(Error),
    HttpStatus {
        status: u16,
        url: String,
        body: String,
    },
    Json(Error),
    JsonPath(String),
    Auth(String),
    RateLimited(Duration),
    Url(String),
    Transform(String),
    Config(String),
    Source(String),
    Sink(String),
    QualityFailure {
        check: String,
        message: String,
    },
    SchemaDrift {
        columns: Vec<String>,
        message: String,
    },
    PolicyViolation {
        rule: String,
        column: String,
        message: String,
    },
    BudgetExceeded {
        budget: String,
        limit: u64,
        actual: u64,
    },
    ProfileDrift {
        columns: Vec<String>,
        message: String,
    },
    ContractViolation {
        version: String,
        message: String,
    },
    State(String),
    StateIncompatible {
        key: String,
        found: String,
        expected: String,
    },
    CircuitOpen {
        failures: u32,
        cooldown: Duration,
    },
    Custom(Box<dyn Error + Send + Sync>),
}

All possible errors returned by faucet-stream.

#[non_exhaustive]: this enum demonstrably grows (QualityFailure, CircuitOpen, SchemaDrift, ContractViolation all arrived post-1.0) and it is the one type every third-party connector author touches. Marking it keeps the next variant a minor release instead of a forced major for faucet-core and everything downstream. Match with a _ arm.

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.

Http(Error)

HttpStatus

An HTTP response with a non-success status code.

Contains the status code, URL, and (truncated) response body for debugging. Whether this error is retriable depends on the status code — see FaucetError::is_retriable.

Fields

status: u16

url: String

body: String

Json(Error)

JsonPath(String)

Auth(String)

RateLimited(Duration)

The server responded with HTTP 429 Too Many Requests. The inner value is the duration to wait before retrying, parsed from the Retry-After response header (default: 60 s).

Url(String)

A URL could not be constructed or parsed.

Transform(String)

A record transform could not be compiled or applied (e.g. invalid regex).

Config(String)

A configuration or validation error (e.g. invalid endpoint, missing descriptor).

Source(String)

A source operation failed (e.g. database query error, file read error).

Sink(String)

A sink operation failed (e.g. BigQuery insert error).

QualityFailure

A data-quality check failed under an abort policy.

Fields

check: String

message: String

SchemaDrift

An incoming page’s shape diverged from the destination schema under an on_drift: fail (or on_incompatible: fail) policy.

Fields

columns: Vec<String>

message: String

PolicyViolation

A data-flow policy rule was violated (#702): at run time a labelled value headed for a sink the rule does not allow, or a static check refused the run before it started.

Fields

rule: String

column: String

message: String

BudgetExceeded

A run budget ceiling was crossed (#703): budget names the ceiling (max_records / max_bytes / max_duration_secs), limit its value and actual what the run reached or would have reached. A records / bytes crossing refuses the whole page before it is written, so the bookmark never advances past it; a duration crossing cancels the run cooperatively at the next page boundary.

Fields

budget: String

limit: u64

actual: u64

ProfileDrift

A run’s learned column profile drifted from its baseline under a profiling.on_drift: fail policy (#708). Raised after the run’s data is written: the failure marks the run, it does not undo it.

Fields

columns: Vec<String>

message: String

ContractViolation

A record breached the pipeline’s data contract under an on_breach: fail policy. version is the contract version the record was validated against.

Fields

version: String

message: String

State(String)

A state-store operation failed (read/write/delete of a replication bookmark, checkpoint, or other persisted pipeline state).

StateIncompatible

A stored state value this release or this source cannot read (#736): written by a newer faucet (a newer state format or bookmark schema) or by a different source. Raised before anything is read from the source, instead of guessing at the shape — which would silently re-sync or skip.

Fields

key: String

The state key.

found: String

What is stored.

expected: String

What this release and source read.

CircuitOpen

The resilience circuit breaker opened after repeated failures; the run is aborted fast. cooldown is advisory for the orchestration layer (e.g. faucet schedule delays re-entry by this duration).

Fields

failures: u32

cooldown: Duration

Custom(Box<dyn Error + Send + Sync>)

A custom error from a third-party connector.

Use this to wrap your own error types without losing the error chain:

use faucet_core::FaucetError;
let err = FaucetError::Custom(Box::new(std::io::Error::new(
    std::io::ErrorKind::Other,
    "my connector failed",
)));

Implementations

impl FaucetError

pub fn sink_status( status: Option<u16>, url: impl Into<String>, message: String, ) -> FaucetError

A storage client’s failure, typed by its HTTP status when it has one: a 429 or 5xx becomes HttpStatus (so the resilience policy retries it) with message as the body; anything else, including a failure with no response, is a Sink error carrying message.

pub fn is_retriable(&self) -> bool

Whether this error is transient and the request should be retried.

Retriable errors:

• Network / connection errors (Http from reqwest)
• Server errors (5xx status codes)
• Rate limiting (429 — handled separately with Retry-After)

Non-retriable errors:

• Client errors (4xx except 429)
• JSON parse / JSONPath / auth / transform errors

Trait Implementations

impl Debug for FaucetError

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

Formats the value using the given formatter.

impl Display for FaucetError

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

Formats the value using the given formatter.

impl Error for FaucetError

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<Box<dyn Error + Send + Sync>> for FaucetError

fn from(source: Box<dyn Error + Send + Sync>) -> FaucetError

Converts to this type from the input type.

impl From<Error> for FaucetError

fn from(source: Error) -> FaucetError

Converts to this type from the input type.

impl From<Error> for FaucetError

fn from(source: Error) -> FaucetError

Converts to this type from the input type.