Struct js_sys::Object

#[repr(transparent)]
pub struct Object { /* private fields */ }

Implementations

impl Object

pub fn assign(target: &Object, source: &Object) -> Object

The Object.assign() method is used to copy the values of all enumerable own properties from one or more source objects to a target object. It will return the target object.

MDN documentation

impl Object

pub fn assign2(target: &Object, source1: &Object, source2: &Object) -> Object

The Object.assign() method is used to copy the values of all enumerable own properties from one or more source objects to a target object. It will return the target object.

MDN documentation

impl Object

pub fn assign3(
    target: &Object,
    source1: &Object,
    source2: &Object,
    source3: &Object
) -> Object

The Object.assign() method is used to copy the values of all enumerable own properties from one or more source objects to a target object. It will return the target object.

MDN documentation

impl Object

pub fn create(prototype: &Object) -> Object

The Object.create() method creates a new object, using an existing object to provide the newly created object’s prototype.

MDN documentation

impl Object

pub fn define_property(
    obj: &Object,
    prop: &JsValue,
    descriptor: &Object
) -> Object

The static method Object.defineProperty() defines a new property directly on an object, or modifies an existing property on an object, and returns the object.

MDN documentation

impl Object

pub fn define_properties(obj: &Object, props: &Object) -> Object

The Object.defineProperties() method defines new or modifies existing properties directly on an object, returning the object.

MDN documentation

impl Object

pub fn entries(object: &Object) -> Array

The Object.entries() method returns an array of a given object’s own enumerable property [key, value] pairs, in the same order as that provided by a for…in loop (the difference being that a for-in loop enumerates properties in the prototype chain as well).

MDN documentation

impl Object

pub fn freeze(value: &Object) -> Object

The Object.freeze() method freezes an object: that is, prevents new properties from being added to it; prevents existing properties from being removed; and prevents existing properties, or their enumerability, configurability, or writability, from being changed, it also prevents the prototype from being changed. The method returns the passed object.

MDN documentation

impl Object

pub fn get_own_property_descriptor(obj: &Object, prop: &JsValue) -> JsValue

The Object.getOwnPropertyDescriptor() method returns a property descriptor for an own property (that is, one directly present on an object and not in the object’s prototype chain) of a given object.

MDN documentation

impl Object

pub fn get_own_property_descriptors(obj: &Object) -> JsValue

The Object.getOwnPropertyDescriptors() method returns all own property descriptors of a given object.

MDN documentation

impl Object

pub fn get_own_property_names(obj: &Object) -> Array

The Object.getOwnPropertyNames() method returns an array of all properties (including non-enumerable properties except for those which use Symbol) found directly upon a given object.

MDN documentation

impl Object

pub fn get_own_property_symbols(obj: &Object) -> Array

The Object.getOwnPropertySymbols() method returns an array of all symbol properties found directly upon a given object.

MDN documentation

impl Object

pub fn get_prototype_of(obj: &JsValue) -> Object

The Object.getPrototypeOf() method returns the prototype (i.e. the value of the internal [[Prototype]] property) of the specified object.

MDN documentation

impl Object

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

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

impl Object

pub fn is(value_1: &JsValue, value_2: &JsValue) -> bool

The Object.is() method determines whether two values are the same value.

MDN documentation

impl Object

pub fn is_extensible(object: &Object) -> bool

The Object.isExtensible() method determines if an object is extensible (whether it can have new properties added to it).

MDN documentation

impl Object

pub fn is_frozen(object: &Object) -> bool

The Object.isFrozen() determines if an object is frozen.

MDN documentation

impl Object

pub fn is_sealed(object: &Object) -> bool

The Object.isSealed() method determines if an object is sealed.

MDN documentation

impl Object

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

impl Object

pub fn keys(object: &Object) -> Array

The Object.keys() method returns an array of a given object’s property names, in the same order as we get with a normal loop.

MDN documentation

impl Object

pub fn new() -> Object

The Object constructor creates an object wrapper.

MDN documentation

impl Object

pub fn prevent_extensions(object: &Object)

The Object.preventExtensions() method prevents new properties from ever being added to an object (i.e. prevents future extensions to the object).

MDN documentation

impl Object

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

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

MDN documentation

impl Object

pub fn seal(value: &Object) -> Object

The Object.seal() method seals an object, preventing new properties from being added to it and marking all existing properties as non-configurable. Values of present properties can still be changed as long as they are writable.

MDN documentation

impl Object

pub fn set_prototype_of(object: &Object, prototype: &Object) -> Object

The Object.setPrototypeOf() method sets the prototype (i.e., the internal [[Prototype]] property) of a specified object to another object or null.

MDN documentation

impl Object

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

impl Object

pub fn to_string(&self) -> JsString

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

MDN documentation

impl Object

pub fn value_of(&self) -> Object

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

MDN documentation

impl Object

pub fn values(object: &Object) -> Array

The Object.values() method returns an array of a given object’s own enumerable property values, in the same order as that provided by a for...in loop (the difference being that a for-in loop enumerates properties in the prototype chain as well).

MDN documentation

impl Object

pub fn try_from(val: &JsValue) -> Option<&Object>

Returns the Object value of this JS value if it’s an instance of an object.

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

Methods from Deref<Target = JsValue>

pub const NULL: JsValue = JsValue{ idx: JSIDX_NULL, _marker: marker::PhantomData,}

pub const UNDEFINED: JsValue = JsValue{ idx: JSIDX_UNDEFINED, _marker: marker::PhantomData,}

pub const TRUE: JsValue = JsValue{ idx: JSIDX_TRUE, _marker: marker::PhantomData,}

pub const FALSE: JsValue = JsValue{ idx: JSIDX_FALSE, _marker: marker::PhantomData,}

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_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_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<JsValue> for Object

fn as_ref(&self) -> &JsValue

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

impl AsRef<Object> for Array

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for ArrayBuffer

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Boolean

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Collator

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for DataView

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Date

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for DateTimeFormat

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Error

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for EvalError

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Float32Array

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Float64Array

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Function

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Generator

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Instance

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Int16Array

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Int32Array

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Int8Array

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for JSON

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for JsString

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Map

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Math

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Memory

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Module

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Number

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for NumberFormat

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Object

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for PluralRules

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Promise

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for RangeError

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for ReferenceError

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Reflect

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for RegExp

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Set

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for SyntaxError

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Table

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for TypeError

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Uint16Array

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Uint32Array

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Uint8Array

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for Uint8ClampedArray

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for UriError

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for WeakMap

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for WeakSet

fn as_ref(&self) -> &Object

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

impl Clone for Object

fn clone(&self) -> Object

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Object

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

Formats the value using the given formatter.

impl Deref for Object

type Target = JsValue

The resulting type after dereferencing.

fn deref(&self) -> &JsValue

Dereferences the value.

impl From<Array> for Object

fn from(obj: Array) -> Object

Converts to this type from the input type.

impl From<ArrayBuffer> for Object

fn from(obj: ArrayBuffer) -> Object

Converts to this type from the input type.

impl From<Boolean> for Object

fn from(obj: Boolean) -> Object

Converts to this type from the input type.

impl From<Collator> for Object

fn from(obj: Collator) -> Object

Converts to this type from the input type.

impl From<DataView> for Object

fn from(obj: DataView) -> Object

Converts to this type from the input type.

impl From<Date> for Object

fn from(obj: Date) -> Object

Converts to this type from the input type.

impl From<DateTimeFormat> for Object

fn from(obj: DateTimeFormat) -> Object

Converts to this type from the input type.

impl From<Error> for Object

fn from(obj: Error) -> Object

Converts to this type from the input type.

impl From<EvalError> for Object

fn from(obj: EvalError) -> Object

Converts to this type from the input type.

impl From<Float32Array> for Object

fn from(obj: Float32Array) -> Object

Converts to this type from the input type.

impl From<Float64Array> for Object

fn from(obj: Float64Array) -> Object

Converts to this type from the input type.

impl From<Function> for Object

fn from(obj: Function) -> Object

Converts to this type from the input type.

impl From<Generator> for Object

fn from(obj: Generator) -> Object

Converts to this type from the input type.

impl From<Instance> for Object

fn from(obj: Instance) -> Object

Converts to this type from the input type.

impl From<Int16Array> for Object

fn from(obj: Int16Array) -> Object

Converts to this type from the input type.

impl From<Int32Array> for Object

fn from(obj: Int32Array) -> Object

Converts to this type from the input type.

impl From<Int8Array> for Object

fn from(obj: Int8Array) -> Object

Converts to this type from the input type.

impl From<JSON> for Object

fn from(obj: JSON) -> Object

Converts to this type from the input type.

impl From<JsString> for Object

fn from(obj: JsString) -> Object

Converts to this type from the input type.

impl From<JsValue> for Object

fn from(obj: JsValue) -> Object

Converts to this type from the input type.

impl From<Map> for Object

fn from(obj: Map) -> Object

Converts to this type from the input type.

impl From<Math> for Object

fn from(obj: Math) -> Object

Converts to this type from the input type.

impl From<Memory> for Object

fn from(obj: Memory) -> Object

Converts to this type from the input type.

impl From<Module> for Object

fn from(obj: Module) -> Object

Converts to this type from the input type.

impl From<Number> for Object

fn from(obj: Number) -> Object

Converts to this type from the input type.

impl From<NumberFormat> for Object

fn from(obj: NumberFormat) -> Object

Converts to this type from the input type.

impl From<Object> for JsValue

fn from(obj: Object) -> JsValue

Converts to this type from the input type.

impl From<PluralRules> for Object

fn from(obj: PluralRules) -> Object

Converts to this type from the input type.

impl From<Promise> for Object

fn from(obj: Promise) -> Object

Converts to this type from the input type.

impl From<RangeError> for Object

fn from(obj: RangeError) -> Object

Converts to this type from the input type.

impl From<ReferenceError> for Object

fn from(obj: ReferenceError) -> Object

Converts to this type from the input type.

impl From<Reflect> for Object

fn from(obj: Reflect) -> Object

Converts to this type from the input type.

impl From<RegExp> for Object

fn from(obj: RegExp) -> Object

Converts to this type from the input type.

impl From<Set> for Object

fn from(obj: Set) -> Object

Converts to this type from the input type.

impl From<SyntaxError> for Object

fn from(obj: SyntaxError) -> Object

Converts to this type from the input type.

impl From<Table> for Object

fn from(obj: Table) -> Object

Converts to this type from the input type.

impl From<TypeError> for Object

fn from(obj: TypeError) -> Object

Converts to this type from the input type.

impl From<Uint16Array> for Object

fn from(obj: Uint16Array) -> Object

Converts to this type from the input type.

impl From<Uint32Array> for Object

fn from(obj: Uint32Array) -> Object

Converts to this type from the input type.

impl From<Uint8Array> for Object

fn from(obj: Uint8Array) -> Object

Converts to this type from the input type.

impl From<Uint8ClampedArray> for Object

fn from(obj: Uint8ClampedArray) -> Object

Converts to this type from the input type.

impl From<UriError> for Object

fn from(obj: UriError) -> Object

Converts to this type from the input type.

impl From<WeakMap> for Object

fn from(obj: WeakMap) -> Object

Converts to this type from the input type.

impl From<WeakSet> for Object

fn from(obj: WeakSet) -> Object

Converts to this type from the input type.

impl FromWasmAbi for Object

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: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl<'a> IntoWasmAbi for &'a Object

type Abi = <&'a JsValue 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 IntoWasmAbi for Object

type Abi = <JsValue 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 JsCast for Object

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

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

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

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

fn has_type<T>(&self) -> boolwhere
    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) -> Twhere
    T: JsCast,

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

fn unchecked_ref<T>(&self) -> &Twhere
    T: JsCast,

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

fn is_instance_of<T>(&self) -> boolwhere
    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 OptionFromWasmAbi for Object

fn is_none(abi: &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<'a> OptionIntoWasmAbi for &'a Object

fn none() -> Self::Abi

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

impl OptionIntoWasmAbi for Object

fn none() -> Self::Abi

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

impl RefFromWasmAbi for Object

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Object>

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 WasmDescribe for Object

fn describe()