Enum HookError 

pub enum HookError {
    AuthFailed {
        reason: String,
    },
    ProtocolMismatch {
        reason: String,
    },
    Disconnected {
        reason: String,
    },
    SchemaInvalid {
        reason: String,
    },
    SinkClosed,
    Other(String),
}

Failure modes reported by a hook to the runtime supervisor. The supervisor decides whether to restart, escalate to requires_attention, or surface as a user error.

Variants

AuthFailed

Source-specific authentication failed (token expired, scope mismatch, etc.). The supervisor marks the hook as AuthFailed and does not auto-restart.

Fields

reason: String

ProtocolMismatch

Source negotiated an incompatible protocol version. Distinct from AuthFailed because UX should suggest “upgrade client/source” not “re-login”.

Fields

reason: String

Disconnected

Transport closed cleanly or due to a recoverable network error. Supervisor restarts with exponential backoff.

Fields

reason: String

SchemaInvalid

The source produced a frame that did not match the declared schema. Supervisor records and may restart; if it persists the hook is moved to AuthFailed-equivalent requires_attention.

Fields

reason: String

SinkClosed

Sink was dropped — the runtime is shutting down. Hook should exit promptly.

Other(String)

Catch-all for unexpected errors so adapters do not need a custom error enum just to surface odd one-off failures.

Trait Implementations

impl Clone for HookError

fn clone(&self) -> HookError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HookError

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

Formats the value using the given formatter.

impl Display for HookError

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

Formats the value using the given formatter.

impl Error for HookError

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.