Enum WasmEncodedResult 

pub enum WasmEncodedResult<T> {
    Success {
        value: T,
        error: Option<WasmEncodedError>,
    },
    Err {
        value: Option<T>,
        error: WasmEncodedError,
    },
}

A generic result enum that holds info of a rust Result that is serializable natively to JS/TS through wasm bindgen, so binding functions can return it normally in JS/TS instead of throwing.

Used in [wasm_bindgen_utils_macros::wasm_export!] as the returning type of exporting wasm binding functions.

Variants

Success

Success variant that contains an instance of T in valuefield with a Option::None error field

Fields

value: T

error: Option<WasmEncodedError>

Err

Error variant that contains an instance of WasmEncodedError in error field with a Option::None value field

Fields

value: Option<T>

error: WasmEncodedError

Implementations

impl<T> WasmEncodedResult<T>

where T: Serialize + for<'de> Deserialize<'de>,

pub fn try_into_js_value(&self) -> Result<JsValue, Error>

A simple helpful wrapper for serde_wasm_bindgen::to_value as self method for easy accessible conversion

pub fn try_from_js_value(js: JsValue) -> Result<Self, Error>

A simple helpful wrapper for serde_wasm_bindgen::from_value as Self method for easy accessible conversion

impl<T> WasmEncodedResult<T>

pub fn success(value: T) -> Self

Creates a success instance from the given type

pub fn error<E: Into<WasmEncodedError>>(err: E) -> Self

Creates an error instance from the given type

Trait Implementations

impl<T: Clone> Clone for WasmEncodedResult<T>

fn clone(&self) -> WasmEncodedResult<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for WasmEncodedResult<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for WasmEncodedResult<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, E: Into<WasmEncodedError>> From<Result<T, E>> for WasmEncodedResult<T>

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

Converts to this type from the input type.

impl<T> From<WasmEncodedResult<T>> for JsValue

where T: Serialize + for<'de> Deserialize<'de>,

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

Converts to this type from the input type.

impl<T> FromWasmAbi for WasmEncodedResult<T>

where T: Serialize + for<'de> Deserialize<'de>,

type Abi = <<WasmEncodedResult<T> as Tsify>::JsType as FromWasmAbi>::Abi

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

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

Recover a Self from Self::Abi.

impl<T> IntoWasmAbi for WasmEncodedResult<T>

where T: Serialize + for<'de> Deserialize<'de>,

type Abi = <<WasmEncodedResult<T> as Tsify>::JsType as IntoWasmAbi>::Abi

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

fn into_abi(self) -> Self::Abi

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

impl<T> LongRefFromWasmAbi for WasmEncodedResult<T>

where T: Serialize + for<'de> Deserialize<'de>,

type Abi = <<WasmEncodedResult<T> as Tsify>::JsType as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = Box<WasmEncodedResult<T>>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl<T> OptionFromWasmAbi for WasmEncodedResult<T>

where T: Serialize + for<'de> Deserialize<'de>,

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.

impl<T> OptionIntoWasmAbi for WasmEncodedResult<T>

where T: Serialize + for<'de> Deserialize<'de>,

fn none() -> Self::Abi

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

impl<T: PartialEq> PartialEq for WasmEncodedResult<T>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> RefFromWasmAbi for WasmEncodedResult<T>

where T: Serialize + for<'de> Deserialize<'de>,

type Abi = <<WasmEncodedResult<T> as Tsify>::JsType as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = Box<WasmEncodedResult<T>>

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.

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

Recover a Self::Anchor from Self::Abi.

impl<T> Serialize for WasmEncodedResult<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> TryFromJsValue for WasmEncodedResult<T>

where T: Serialize + for<'de> Deserialize<'de>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from_js_value(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> Tsify for WasmEncodedResult<T>

const DECL: &'static str = "export type WasmEncodedResult<T> = { value: T; error: undefined } | { value: undefined; error: WasmEncodedError };"

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,

impl<T> VectorFromWasmAbi for WasmEncodedResult<T>

where T: Serialize + for<'de> Deserialize<'de>,

type Abi = <Box<[<WasmEncodedResult<T> as Tsify>::JsType]> as FromWasmAbi>::Abi

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

impl<T> VectorIntoJsValue for WasmEncodedResult<T>

where T: Serialize + for<'de> Deserialize<'de>,

fn vector_into_jsvalue(vector: Box<[Self]>) -> JsValue

impl<T> VectorIntoWasmAbi for WasmEncodedResult<T>

where T: Serialize + for<'de> Deserialize<'de>,

type Abi = <Box<[<WasmEncodedResult<T> as Tsify>::JsType]> as IntoWasmAbi>::Abi

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

impl<T> WasmDescribe for WasmEncodedResult<T>

fn describe()

impl<T> WasmDescribeVector for WasmEncodedResult<T>

fn describe_vector()

impl<T> StructuralPartialEq for WasmEncodedResult<T>