dioxus/examples/core_reference/errorhandling.rs

90 lines
3.3 KiB
Rust
Raw Normal View History

2021-10-24 17:30:36 +00:00
//! Example: Error Handling
2021-07-20 23:03:49 +00:00
//! ------------------------
//!
//! Error handling in Dioxus comes in a few flavors. Because Dioxus is a Rust project, Options and Results are obviously
2021-10-24 17:30:36 +00:00
//! the go-to way of wrapping possibly-errored data. However, if a component fails when "unwrapping," everything will crash,
2021-07-20 23:03:49 +00:00
//! the page will deadlock, and your users will be sad.
//!
//! So, obviously, you need to handle your errors.
//!
//! Fortunately, it's easy to avoid panics, even during quick prototyping.
//!
2021-10-24 17:30:36 +00:00
//! Here are a few strategies:
//! - Leverage the ability to return "None" and propagate None directly
//! - Instead of propagating "None" manually, use the "?" syntax sugar
//! - Convert Results into Options with .ok()
2021-07-20 23:03:49 +00:00
//! - Manually display a separate screen by matching on Options/Results
//!
2021-10-24 17:30:36 +00:00
//! There *are* plans to add helpful screens for when apps completely panic in Wasm. However, you should really try to
2021-07-20 23:03:49 +00:00
//! avoid panicking.
use dioxus::prelude::*;
fn main() {}
/// This is one way to go about error handling (just toss things away with unwrap).
/// However, if you get it wrong, the whole app will crash.
/// This is pretty flimsy.
pub fn App(cx: Scope) -> Element {
2021-07-20 23:03:49 +00:00
let data = get_data().unwrap();
cx.render(rsx!( div { "{data}" } ))
}
2021-07-20 23:03:49 +00:00
/// This is a pretty verbose way of error handling
/// However, it's still pretty good since we don't panic, just fail to render anything
pub fn App1(cx: Scope) -> Element {
2021-07-20 23:03:49 +00:00
let data = match get_data() {
Some(data) => data,
None => return None,
};
cx.render(rsx!( div { "{data}" } ))
}
2021-07-20 23:03:49 +00:00
/// This is an even better form of error handling.
/// However, it _does_ make the component go blank, which might not be desirable.
///
/// This type of error handling is good when you have "selectors" that produce Some/None based on some state that's
2021-10-24 17:30:36 +00:00
/// already controlled higher in the tree. i.e. displaying a "Username" in a component that should only be shown if
2021-07-20 23:03:49 +00:00
/// a user is logged in.
///
/// Dioxus will throw an error in the console if the None-path is ever taken.
pub fn App2(cx: Scope) -> Element {
2021-07-20 23:03:49 +00:00
let data = get_data()?;
cx.render(rsx!( div { "{data}" } ))
}
2021-07-20 23:03:49 +00:00
/// This is top-tier error handling since it displays a failure state.
///
/// However, the error is lacking in context.
pub fn App3(cx: Scope) -> Element {
match get_data() {
Some(data) => cx.render(rsx!( div { "{data}" } )),
None => cx.render(rsx!( div { "Failed to load data :(" } )),
}
}
2021-07-20 23:03:49 +00:00
2021-10-24 17:30:36 +00:00
/// For errors that return results, it's possible to short-circuit the match-based error handling with `.ok()` which converts
/// a Result<T, V> into an Option<T> and lets you abort rendering by early-returning `None`
pub fn App4(cx: Scope) -> Element {
2021-07-20 23:03:49 +00:00
let data = get_data_err().ok()?;
cx.render(rsx!( div { "{data}" } ))
}
2021-07-20 23:03:49 +00:00
/// This is great error handling since it displays a failure state... with context!
///
2021-10-24 17:30:36 +00:00
/// Hopefully you'll never need to display a screen like this. It's rather bad taste
pub fn App5(cx: Scope) -> Element {
match get_data_err() {
Ok(data) => cx.render(rsx!( div { "{data}" } )),
Err(c) => cx.render(rsx!( div { "Failed to load data: {c}" } )),
}
}
2021-07-20 23:03:49 +00:00
// this fetching function produces "nothing"
fn get_data() -> Option<String> {
None
}
// this fetching function produces "nothing"
fn get_data_err() -> Result<String, &'static str> {
Result::Err("Failed!")
}