sycamore::web::js_sys::wasm_bindgen

Struct JsError

source
pub struct JsError { /* private fields */ }
Expand description

Convenience type for use on exported fn() -> Result<T, JsError> functions, where you wish to throw a JavaScript Error object.

You can get wasm_bindgen to throw basic errors by simply returning Err(JsError::new("message")) from such a function.

For more complex error handling, JsError implements From<T> where T: std::error::Error by converting it to a string, so you can use it with ?. Many Rust error types already do this, and you can use thiserror to derive Display implementations easily or use any number of boxed error types that implement it already.

To allow JavaScript code to catch only your errors, you may wish to add a subclass of Error in a JS module, and then implement Into<JsValue> directly on a type and instantiate that subclass. In that case, you would not need JsError at all.

§Basic example

use wasm_bindgen::prelude::*;

#[wasm_bindgen]
pub fn throwing_function() -> Result<(), JsError> {
    Err(JsError::new("message"))
}

§Complex Example

use wasm_bindgen::prelude::*;

#[derive(Debug, Clone)]
enum MyErrorType {
    SomeError,
}

use core::fmt;
impl std::error::Error for MyErrorType {}
impl fmt::Display for MyErrorType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "display implementation becomes the error message")
    }
}

fn internal_api() -> Result<(), MyErrorType> {
    Err(MyErrorType::SomeError)
}

#[wasm_bindgen]
pub fn throwing_function() -> Result<(), JsError> {
    internal_api()?;
    Ok(())
}

Implementations§

source§

impl JsError

source

pub fn new(s: &str) -> JsError

Construct a JavaScript Error object with a string message

Trait Implementations§

source§

impl Clone for JsError

source§

fn clone(&self) -> JsError

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for JsError

source§

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

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

impl<E> From<E> for JsError
where E: Error,

source§

fn from(error: E) -> JsError

Converts to this type from the input type.
source§

impl From<JsError> for JsValue

source§

fn from(error: JsError) -> JsValue

Converts to this type from the input type.
source§

impl IntoWasmAbi for JsError

source§

type Abi = <JsValue as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.
source§

fn into_abi(self) -> <JsError as IntoWasmAbi>::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

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, dst: *mut T)

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

impl<T> From<!> for T

source§

fn from(t: !) -> T

Converts to this type from the input type.
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> ReturnWasmAbi for T
where T: IntoWasmAbi,

source§

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi
source§

fn return_abi(self) -> <T as ReturnWasmAbi>::Abi

Same as IntoWasmAbi::into_abi, except that it may throw and never return in the case of Err.
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, 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.