Struct DisposableStack 

pub struct DisposableStack { /* private fields */ }

A DisposableStack aggregates disposable resources, disposing them in reverse order of registration when dispose() is called.

Callbacks registered with adopt() and defer() run later, at disposal time, so they are taken as ScopedClosures which must outlive the stack’s disposal. A stack disposed within the scope its closures live in needs nothing more. One that outlives that scope, through move() or by being stored, needs 'static Closures handed to JS with Closure::forget; a disposer runs once, so Closure::once frees its captures as soon as it has run.

MDN documentation

Implementations

impl DisposableStack

pub fn new() -> DisposableStack

Creates a new, empty DisposableStack.

MDN documentation

impl DisposableStack

pub fn disposed(&self) -> bool

The disposed accessor property returns whether this stack has already been disposed.

MDN documentation

impl DisposableStack

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

The dispose() method disposes every resource in the stack in reverse order of registration. Errors thrown by disposers are collected into a SuppressedError chain and rethrown.

MDN documentation

impl DisposableStack

pub fn use_<T>(&self, value: &T) -> Result<T, JsValue>

where T: ErasableGenericBorrow<JsValue> + ErasableGenericOwn<JsValue>,

The use() method registers a value implementing Symbol.dispose for disposal and returns it. Throws a TypeError if the value is not null, undefined or disposable.

MDN documentation

impl DisposableStack

pub fn adopt<'a, T>( &self, value: &T, on_dispose: &ScopedClosure<'a, dyn FnMut(T)>, ) -> Result<T, JsValue>

where T: ErasableGenericBorrow<JsValue> + ErasableGenericOwn<JsValue>, ScopedClosure<'a, dyn FnMut(T)>: ErasableGenericBorrow<ScopedClosure<'a, dyn FnMut(JsValue)>>,

The adopt() method registers a non-disposable value together with a callback to dispose it, and returns the value.

MDN documentation

impl DisposableStack

pub fn defer( &self, on_dispose: &ScopedClosure<'_, dyn FnMut()>, ) -> Result<(), JsValue>

The defer() method registers a callback to run when the stack is disposed.

MDN documentation

impl DisposableStack

pub fn move_(&self) -> Result<DisposableStack, JsValue>

The move() method transfers every resource into a new DisposableStack, marking this one as disposed.

MDN documentation

Methods from Deref<Target = Object>

pub fn constructor(&self) -> Function

The constructor property returns a reference to the Object constructor function that created the instance object.

MDN documentation

pub fn has_own_property(&self, property: &JsValue) -> bool

👎Deprecated:

Use Object::hasOwn instead.

The hasOwnProperty() method returns a boolean indicating whether the object has the specified property as its own property (as opposed to inheriting it).

MDN documentation

pub fn is_prototype_of(&self, value: &JsValue) -> bool

The isPrototypeOf() method checks if an object exists in another object’s prototype chain.

MDN documentation

pub fn property_is_enumerable(&self, property: &JsValue) -> bool

The propertyIsEnumerable() method returns a Boolean indicating whether the specified property is enumerable.

MDN documentation

pub fn to_locale_string(&self) -> JsString

The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.

MDN documentation

pub fn to_string(&self) -> JsString

The toString() method returns a string representing the object.

MDN documentation

pub fn to_js_string(&self) -> JsString

The toString() method returns a string representing the object.

MDN documentation

pub fn value_of(&self) -> Object

The valueOf() method returns the primitive value of the specified object.

MDN documentation

Methods from Deref<Target = JsValue>

pub fn as_f64(&self) -> Option<f64>

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

pub fn as_string(&self) -> Option<String>

If this JS value is a string value, this function copies the JS string value into Wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_null_or_undefined(&self) -> bool

Tests whether this JS value is null or undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

pub fn is_array(&self) -> bool

Tests whether this JS value is an instance of Array.

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

pub fn js_in(&self, obj: &JsValue) -> bool

Applies the binary in JS operator on the two JsValues.

MDN documentation

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

pub fn loose_eq(&self, other: &JsValue) -> bool

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

pub fn pow(&self, rhs: &JsValue) -> JsValue

Applies the binary ** JS operator on the two JsValues.

MDN documentation

pub fn lt(&self, other: &JsValue) -> bool

Applies the binary < JS operator on the two JsValues.

MDN documentation

pub fn le(&self, other: &JsValue) -> bool

Applies the binary <= JS operator on the two JsValues.

MDN documentation

pub fn ge(&self, other: &JsValue) -> bool

Applies the binary >= JS operator on the two JsValues.

MDN documentation

pub fn gt(&self, other: &JsValue) -> bool

Applies the binary > JS operator on the two JsValues.

MDN documentation

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations

impl AsRef<DisposableStack> for DisposableStack

fn as_ref(&self) -> &DisposableStack

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<JsValue> for DisposableStack

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Object> for DisposableStack

fn as_ref(&self) -> &Object

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for DisposableStack

fn clone(&self) -> DisposableStack

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DisposableStack

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

Formats the value using the given formatter.

impl Default for DisposableStack

fn default() -> DisposableStack

Returns the “default value” for a type.

impl Deref for DisposableStack

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl Eq for DisposableStack

impl ErasableGeneric for DisposableStack

type Repr = JsValue

The singular concrete type that all generic variants can be transmuted on.

impl From<DisposableStack> for JsValue

fn from(obj: DisposableStack) -> JsValue

Converts to this type from the input type.

impl From<DisposableStack> for Object

fn from(obj: DisposableStack) -> Object

Converts to this type from the input type.

impl From<JsValue> for DisposableStack

fn from(obj: JsValue) -> DisposableStack

Converts to this type from the input type.

impl FromWasmAbi for DisposableStack

type Abi = <JsValue as FromWasmAbi>::Abi

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

unsafe fn from_abi(js: <DisposableStack as FromWasmAbi>::Abi) -> DisposableStack

Recover a Self from Self::Abi.

impl IntoJsGeneric for DisposableStack

where DisposableStack: JsGeneric,

type JsCanon = DisposableStack

The canonical JsGeneric form of this type.

fn to_js(self) -> DisposableStack

Produce the canonical JsGeneric value for self.

impl IntoWasmAbi for DisposableStack

type Abi = <JsValue as IntoWasmAbi>::Abi

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

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

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

impl<'__wbg_ref> IntoWasmAbi for &'__wbg_ref DisposableStack

type Abi = <&'__wbg_ref JsValue as IntoWasmAbi>::Abi

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

fn into_abi(self) -> <&'__wbg_ref DisposableStack as IntoWasmAbi>::Abi

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

impl JsCast for DisposableStack

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> DisposableStack

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &DisposableStack

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn has_type<T>(&self) -> bool

where T: JsCast,

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> T

where T: JsCast,

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &T

where T: JsCast,

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> bool

where T: JsCast,

Test whether this JS value is an instance of the type T.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.

impl LongRefFromWasmAbi for DisposableStack

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = DisposableStack

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi( js: <DisposableStack as LongRefFromWasmAbi>::Abi, ) -> <DisposableStack as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl NullableFromWasmAbi for DisposableStack

fn is_null(abi: &<DisposableStack as MaybeFromWasmAbi>::MaybeAbi) -> bool

Tests the ABI value for Nullable::Null.

impl NullableIntoWasmAbi for DisposableStack

fn null() -> <DisposableStack as MaybeIntoWasmAbi>::MaybeAbi

Returns the ABI value for Nullable::Null, which JS reads as null.

impl<'__wbg_ref> NullableIntoWasmAbi for &'__wbg_ref DisposableStack

fn null() -> <&'__wbg_ref DisposableStack as MaybeIntoWasmAbi>::MaybeAbi

Returns the ABI value for Nullable::Null, which JS reads as null.

impl OptionFromWasmAbi for DisposableStack

fn is_none(abi: &<DisposableStack as FromWasmAbi>::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 OptionIntoWasmAbi for DisposableStack

fn none() -> <DisposableStack as IntoWasmAbi>::Abi

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

impl<'__wbg_ref> OptionIntoWasmAbi for &'__wbg_ref DisposableStack

fn none() -> <&'__wbg_ref DisposableStack as IntoWasmAbi>::Abi

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

impl PartialEq for DisposableStack

fn eq(&self, other: &DisposableStack) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Promising for DisposableStack

type Resolution = DisposableStack

The type that this value resolves to.

impl RefFromWasmAbi for DisposableStack

type Abi = <JsValue as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<DisposableStack>

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: <DisposableStack as RefFromWasmAbi>::Abi, ) -> <DisposableStack as RefFromWasmAbi>::Anchor

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

impl UpcastFrom<DisposableStack> for JsValue

impl UpcastFrom<DisposableStack> for JsOption

impl UpcastFrom<DisposableStack> for JsNullable

impl<__UpcastWrapTarget> UpcastFrom<DisposableStack> for Option<__UpcastWrapTarget>

where __UpcastWrapTarget: UpcastFrom<DisposableStack>,

impl<__UpcastWrapTarget> UpcastFrom<DisposableStack> for Nullable<__UpcastWrapTarget>

where __UpcastWrapTarget: UpcastFrom<DisposableStack>,

impl UpcastFrom<DisposableStack> for DisposableStack

impl UpcastFrom<DisposableStack> for JsOption<DisposableStack>

impl UpcastFrom<DisposableStack> for JsNullable<DisposableStack>

impl UpcastFrom<DisposableStack> for Object

impl UpcastFrom<DisposableStack> for JsOption<Object>

impl UpcastFrom<DisposableStack> for JsNullable<Object>

impl VectorRefIntoWasmAbi for DisposableStack

fn slice_into_abi(slice: &[DisposableStack]) -> WasmSlice