Skip to main content

HookError

Struct HookError 

Source
pub struct HookError(/* private fields */);
Expand description

Boxed hook callback error which preserves the concrete source for downcast.

§Effect on the Run

Returning one of these is a decision that the Run should not continue, not a hint that something went wrong. Reef never retries a callback, substitutes a default decision, or carries on with the remaining registrations: the failing boundary short-circuits, and whatever it had composed, staged, or planned is discarded rather than half-applied. Peers registered after the failure are not called, and peers that already ran do not have their contributions kept.

The failure always reaches the caller with the failing registration’s name attached, as an AttributedError. Where it surfaces depends only on which boundary was running:

  • At Run admission, as StartError::Prepare. The Session lease and Agent attachment are rolled back, so admission having failed means nothing was committed and no Run exists.
  • At every other boundary, by ending the Run: its Terminal reports Outcome::Failed with the FailureKind of the boundary that was running — Hook for most, Transcript or ToolCommit for a failed reservation, according to which mutation it was reserving. The retained failure is reachable from the terminal, and the registration name survives the whole chain.

A cancellation observed at the same boundary ends the Run as Cancelled instead; a real callback error is never downgraded to a cancellation.

This is why a degradation the Run can survive should not be reported this way. A mutating scope’s emit_error method publishes a non-fatal fact and leaves the Run running, which is the right shape for a hook whose optional work failed. HookError is for the case where continuing would be wrong.

Implementations§

Source§

impl HookError

Source

pub fn new(error: impl Error + Send + Sync + 'static) -> Self

Retains a concrete callback error without string flattening.

Source

pub fn source_ref(&self) -> &(dyn Error + Send + Sync + 'static)

Returns the retained concrete source.

Trait Implementations§

Source§

impl Clone for HookError

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HookError

Source§

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

Renders every link of the retained chain, each one through Display.

Printing only the outermost link would discard the chain that source_ref retains: a callback error that wraps its own cause reads as a single sentence, and the reason underneath it — the one a reader is usually after — never appears. Walking source states the whole chain.

Display rather than the link’s own Debug, because the cause is whatever a hook handed back: arbitrary text this crate neither writes nor reviews. Display is the rendering those types are contracted to produce, and it is what every other boxed failure in reef prints.

Source§

impl Display for HookError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for HookError

Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.