Enum JsResult

Source
pub enum JsResult<T, E> {
    Ok(T),
    Err(E),
}
Expand description

A Result-like type that translates to/from JavaScript.

In wasm-bindgen, returning a Result raises an exception in JavaScript when the Err variant is given:

https://rustwasm.github.io/docs/wasm-bindgen/reference/types/result.html

When an error should be handled in the UI, it is often more convenient to return an error value than to raise an exception. That’s what this enum does.

Variants§

§

Ok(T)

Contains the success value

§

Err(E)

Contains the error value

Trait Implementations§

Source§

impl<T: Clone, E: Clone> Clone for JsResult<T, E>

Source§

fn clone(&self) -> JsResult<T, E>

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<T: Debug, E: Debug> Debug for JsResult<T, E>

Source§

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

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

impl<'de, T, E> Deserialize<'de> for JsResult<T, E>
where T: Deserialize<'de>, E: Deserialize<'de>,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<T, E> From<JsResult<T, E>> for JsValue
where JsResult<T, E>: Serialize,

Source§

fn from(value: JsResult<T, E>) -> Self

Converts to this type from the input type.
Source§

impl<T> From<Option<T>> for JsResult<T, ()>

Source§

fn from(value: Option<T>) -> Self

Converts to this type from the input type.
Source§

impl<T, E> From<Result<T, E>> for JsResult<T, E>

Source§

fn from(value: Result<T, E>) -> Self

Converts to this type from the input type.
Source§

impl<T, E> FromWasmAbi for JsResult<T, E>
where Self: DeserializeOwned,

Source§

type Abi = <JsType as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.
Source§

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi. Read more
Source§

impl<T, E> IntoWasmAbi for JsResult<T, E>
where JsResult<T, E>: Serialize,

Source§

type Abi = <JsType as IntoWasmAbi>::Abi

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

fn into_abi(self) -> Self::Abi

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

impl<T, E> OptionFromWasmAbi for JsResult<T, E>
where Self: DeserializeOwned,

Source§

fn is_none(js: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.
Source§

impl<T, E> OptionIntoWasmAbi for JsResult<T, E>
where JsResult<T, E>: Serialize,

Source§

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option. Read more
Source§

impl<T: PartialEq, E: PartialEq> PartialEq for JsResult<T, E>

Source§

fn eq(&self, other: &JsResult<T, E>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T, E> RefFromWasmAbi for JsResult<T, E>
where Self: DeserializeOwned,

Source§

type Abi = <JsType as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.
Source§

type Anchor = SelfOwner<JsResult<T, E>>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.
Source§

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi. Read more
Source§

impl<T, E> Serialize for JsResult<T, E>
where T: Serialize, E: Serialize,

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<T, E> Tsify for JsResult<T, E>

Source§

const DECL: &'static str = "/**\n * A `Result`-like type that translates to/from JavaScript.\\n\\nIn `wasm-bindgen`, returning a [`Result`] raises an exception in JavaScript when\\nthe `Err` variant is given:\\n\\n<https://rustwasm.github.io/docs/wasm-bindgen/reference/types/result.html>\\n\\nWhen an error should be handled in the UI, it is often more convenient to return\\nan error value than to raise an exception. That\\\'s what this enum does.\\n\n */\nexport type JsResult<T, E> = { tag: \"Ok\"; content: T } | { tag: \"Err\"; content: E };"

Source§

const SERIALIZATION_CONFIG: SerializationConfig

Source§

type JsType = JsType

§

fn into_js(&self) -> Result<Self::JsType, Error>
where Self: Serialize,

§

fn from_js<T>(js: T) -> Result<Self, Error>
where T: Into<JsValue>, Self: DeserializeOwned,

Source§

impl<T, E> VectorFromWasmAbi for JsResult<T, E>
where Self: DeserializeOwned,

Source§

type Abi = <JsType as VectorFromWasmAbi>::Abi

Source§

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[Self]>

Source§

impl<T, E> VectorIntoWasmAbi for JsResult<T, E>
where JsResult<T, E>: Serialize,

Source§

type Abi = <JsType as VectorIntoWasmAbi>::Abi

Source§

fn vector_into_abi(vector: Box<[Self]>) -> Self::Abi

Source§

impl<T, E> WasmDescribe for JsResult<T, E>

Source§

impl<T, E> WasmDescribeVector for JsResult<T, E>

Source§

impl<T: Eq, E: Eq> Eq for JsResult<T, E>

Source§

impl<T, E> StructuralPartialEq for JsResult<T, E>

Auto Trait Implementations§

§

impl<T, E> Freeze for JsResult<T, E>
where T: Freeze, E: Freeze,

§

impl<T, E> RefUnwindSafe for JsResult<T, E>

§

impl<T, E> Send for JsResult<T, E>
where T: Send, E: Send,

§

impl<T, E> Sync for JsResult<T, E>
where T: Sync, E: Sync,

§

impl<T, E> Unpin for JsResult<T, E>
where T: Unpin, E: Unpin,

§

impl<T, E> UnwindSafe for JsResult<T, E>
where T: UnwindSafe, E: UnwindSafe,

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 u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> 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<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> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,