Skip to main content

ErrorBoundary

Struct ErrorBoundary 

Source
pub struct ErrorBoundary { /* private fields */ }
Expand description

A handle that tracks whether a wrapped subtree has thrown.

The boundary’s phase is exposed via phase() as a Signal<ErrorBoundaryPhase>. The parent component reads that signal to decide whether to render the child or a fallback.

try_with(closure) runs the closure and, if it panics, transitions the boundary to Caught. The closure’s return value (if it didn’t panic) is returned to the caller; if it panicked, an Err is returned containing the panic message.

Implementations§

Source§

impl ErrorBoundary

Inherent implementation of ErrorBoundary.

Source

pub fn new() -> Self

Creates a new ErrorBoundary in the Healthy phase.

Source

pub fn try_with<F, R>(&self, closure: F) -> Result<R, String>
where F: FnOnce() -> R + UnwindSafe,

Runs a closure and, if it panics, transitions the boundary to Caught and returns Err.

On success, the closure’s return value is returned wrapped in Ok. The closure is wrapped in AssertUnwindSafe so it does not have to satisfy UnwindSafe.

§Arguments
  • F: FnOnce() -> R + UnwindSafe - A generic type parameter.
§Returns
  • Result<R, String> - Result of the operation; an Err variant on failure.
Source

pub fn report_error(&self, message: &str) -> String

Feeds an Err straight into the boundary without forcing the caller to panic!.

try_with requires a real panic to transition the phase to Caught, which makes demonstrating the hook from outside tests/ awkward. This helper lets demo / driver code report a failure message via the regular Result channel and still flip the boundary into Caught.

§Arguments
  • &str - The error message to surface.
§Returns
  • String - The same message that was passed in.
Source

pub fn reset(&self)

Transitions the boundary back to Healthy. Useful when invalidating the cache (e.g., after a retry).

Source§

impl ErrorBoundary

Source

pub fn get_phase(&self) -> &Signal<ErrorBoundaryPhase>

Source

pub fn get_mut_phase(&mut self) -> &mut Signal<ErrorBoundaryPhase>

Source

pub fn set_phase(&mut self, val: Signal<ErrorBoundaryPhase>) -> &mut Self

Trait Implementations§

Source§

impl Clone for ErrorBoundary

Source§

fn clone(&self) -> ErrorBoundary

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 Copy for ErrorBoundary

ErrorBoundary is Copy because Signal<ErrorBoundaryPhase> is itself Copy — the signal registry hands out cheap usize addresses.

Source§

impl Debug for ErrorBoundary

Source§

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

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

impl Default for ErrorBoundary

Default-construction for ErrorBoundary.

Source§

fn default() -> Self

Constructs a default ErrorBoundary value.

Source§

impl Display for ErrorBoundary

Formatting / debug-printing for ErrorBoundary.

Source§

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

Formats the ErrorBoundary via the supplied formatter.

§Arguments
  • &mut Formatter<'_> - The formatter receiving the formatted output.
§Returns
  • FmtResult - Result of the formatting operation.

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, <T as TryFrom<U>>::Error>

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.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more