Skip to main content

ErrorBoundaryProps

Struct ErrorBoundaryProps 

Source
pub struct ErrorBoundaryProps<FalFn, Fal, Chil>
where FalFn: FnMut(ArcRwSignal<Errors>) -> Fal + Send + 'static, Fal: IntoView + Send + 'static, Chil: IntoView + Send + 'static,
{ pub children: TypedChildren<Chil>, pub fallback: FalFn, }
Expand description

Props for the ErrorBoundary component.

When you render a Result<_, _> in your view, in the Err case it will render nothing, and search up through the view tree for an <ErrorBoundary/>. This component lets you define a fallback that should be rendered in that error case, allowing you to handle errors within a section of the interface.

#[component]
pub fn ErrorBoundaryExample() -> impl IntoView {
  let (value, set_value) = signal(Ok(0));
  let on_input =
    move |ev| set_value.set(event_target_value(&ev).parse::<i32>());

  view! {
    <input type="text" on:input=on_input/>
    <ErrorBoundary
      fallback=move |_| view! { <p class="error">"Enter a valid number."</p>}
    >
      <p>"Value is: " {move || value.get()}</p>
    </ErrorBoundary>
  }
}

§Beginner’s Tip: ErrorBoundary Requires Your Error To Implement std::error::Error.

ErrorBoundary requires your Result<T,E> to implement IntoView. Result<T,E> only implements IntoView if E implements std::error::Error. So, for instance, if you pass a Result<T,String> where T implements IntoView and attempt to render the error for the purposes of ErrorBoundary you’ll get a compiler error like this.

error[E0599]: the method `into_view` exists for enum `Result<ViewableLoginFlow, String>`, but its trait bounds were not satisfied
   --> src/login.rs:229:32
    |
229 |                     err => err.into_view(),
    |                                ^^^^^^^^^ method cannot be called on `Result<ViewableLoginFlow, String>` due to unsatisfied trait bounds
    |
    = note: the following trait bounds were not satisfied:
            `<&Result<ViewableLoginFlow, std::string::String> as FnOnce<()>>::Output = _`
            which is required by `&Result<ViewableLoginFlow, std::string::String>: leptos::IntoView`
   ... more notes here ...

For more information about how to easily implement Error see thiserror

§Required Props

  • children: TypedChildren<Chil>
    • The elements that will be rendered, which may include one or more Result<_> types.
  • fallback: [FalFn]
    • A fallback that will be shown if an error occurs.

Fields§

§children: TypedChildren<Chil>

The elements that will be rendered, which may include one or more Result<_> types.

§fallback: FalFn

A fallback that will be shown if an error occurs.

Implementations§

Source§

impl<FalFn, Fal, Chil> ErrorBoundaryProps<FalFn, Fal, Chil>
where FalFn: FnMut(ArcRwSignal<Errors>) -> Fal + Send + 'static, Fal: IntoView + Send + 'static, Chil: IntoView + Send + 'static,

Source

pub fn builder() -> ErrorBoundaryPropsBuilder<FalFn, Fal, Chil>

Create a builder for building ErrorBoundaryProps. On the builder, call .children(...), .fallback(...) to set the values of the fields. Finally, call .build() to create the instance of ErrorBoundaryProps.

Trait Implementations§

Source§

impl<FalFn, Fal, Chil> Props for ErrorBoundaryProps<FalFn, Fal, Chil>
where FalFn: FnMut(ArcRwSignal<Errors>) -> Fal + Send + 'static, Fal: IntoView + Send + 'static, Chil: IntoView + Send + 'static,

Source§

type Builder = ErrorBoundaryPropsBuilder<FalFn, Fal, Chil>

Source§

fn builder() -> <ErrorBoundaryProps<FalFn, Fal, Chil> as Props>::Builder

Auto Trait Implementations§

§

impl<FalFn, Fal, Chil> Freeze for ErrorBoundaryProps<FalFn, Fal, Chil>
where FalFn: Freeze,

§

impl<FalFn, Fal, Chil> !RefUnwindSafe for ErrorBoundaryProps<FalFn, Fal, Chil>

§

impl<FalFn, Fal, Chil> Send for ErrorBoundaryProps<FalFn, Fal, Chil>

§

impl<FalFn, Fal, Chil> !Sync for ErrorBoundaryProps<FalFn, Fal, Chil>

§

impl<FalFn, Fal, Chil> Unpin for ErrorBoundaryProps<FalFn, Fal, Chil>
where FalFn: Unpin,

§

impl<FalFn, Fal, Chil> !UnwindSafe for ErrorBoundaryProps<FalFn, Fal, Chil>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<E, T, Request, Encoding> FromReq<Patch<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, T, Request, Encoding> FromReq<Post<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, T, Request, Encoding> FromReq<Put<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, Encoding, Response, T> FromRes<Patch<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<E, Encoding, Response, T> FromRes<Post<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<E, Encoding, Response, T> FromRes<Put<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<E, T, Encoding, Request> IntoReq<Patch<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, T, Encoding, Request> IntoReq<Post<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, T, Encoding, Request> IntoReq<Put<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, Response, Encoding, T> IntoRes<Patch<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<E, Response, Encoding, T> IntoRes<Post<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<E, Response, Encoding, T> IntoRes<Put<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<T> SerializableKey for T

Source§

fn ser_key(&self) -> String

Serializes the key to a unique string. Read more
Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
Source§

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

Source§

type Error = Infallible

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.