Struct js_sys::Object[][src]

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

Implementations

impl Object[src]

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

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[src]

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

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[src]

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

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[src]

pub fn constructor(&self) -> Function[src]

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

MDN documentation

impl Object[src]

pub fn create(prototype: &Object) -> Object[src]

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

MDN documentation

impl Object[src]

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

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[src]

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

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

MDN documentation

impl Object[src]

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

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[src]

pub fn freeze(value: &Object) -> Object[src]

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[src]

pub fn from_entries(iterable: &JsValue) -> Result<Object, JsValue>[src]

The Object.fromEntries() method transforms a list of key-value pairs into an object.

MDN documentation

impl Object[src]

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

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[src]

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

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

MDN documentation

impl Object[src]

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

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[src]

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

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

MDN documentation

impl Object[src]

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

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

MDN documentation

impl Object[src]

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

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[src]

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

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

MDN documentation

impl Object[src]

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

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

MDN documentation

impl Object[src]

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

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

MDN documentation

impl Object[src]

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

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

MDN documentation

impl Object[src]

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

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

MDN documentation

impl Object[src]

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

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[src]

pub fn new() -> Object[src]

The Object constructor creates an object wrapper.

MDN documentation

impl Object[src]

pub fn prevent_extensions(object: &Object)[src]

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[src]

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

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

MDN documentation

impl Object[src]

pub fn seal(value: &Object) -> Object[src]

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[src]

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

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[src]

pub fn to_locale_string(&self) -> JsString[src]

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[src]

pub fn to_string(&self) -> JsString[src]

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

MDN documentation

impl Object[src]

pub fn value_of(&self) -> Object[src]

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

MDN documentation

impl Object[src]

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

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[src]

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

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[src]

pub const UNDEFINED: JsValue[src]

pub const TRUE: JsValue[src]

pub const FALSE: JsValue[src]

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

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[src]

Tests whether this JS value is a JS string.

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

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>[src]

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[src]

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool[src]

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool[src]

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool[src]

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

pub fn is_function(&self) -> bool[src]

Tests whether the type of this JS value is function.

pub fn is_truthy(&self) -> bool[src]

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool[src]

Tests whether the value is “falsy”.

Trait Implementations

impl AsRef<JsValue> for Object[src]

fn as_ref(&self) -> &JsValue[src]

Performs the conversion.

impl AsRef<Object> for Array[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for ArrayBuffer[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for IteratorNext[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Number[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Date[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Object[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for RangeError[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for ReferenceError[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for RegExp[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Set[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for SyntaxError[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for TypeError[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for SharedArrayBuffer[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for UriError[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for WeakMap[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for WeakSet[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Instance[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Module[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Table[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Memory[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for JsString[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Collator[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for DateTimeFormat[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Boolean[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for NumberFormat[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for PluralRules[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Promise[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Int8Array[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Int16Array[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Int32Array[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Uint8Array[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Uint8ClampedArray[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Uint16Array[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Uint32Array[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for DataView[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Float32Array[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Float64Array[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Error[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for EvalError[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Function[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Generator[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl AsRef<Object> for Map[src]

fn as_ref(&self) -> &Object[src]

Performs the conversion.

impl Clone for Object[src]

fn clone(&self) -> Object[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for Object[src]

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

Formats the value using the given formatter. Read more

impl Deref for Object[src]

type Target = JsValue

The resulting type after dereferencing.

fn deref(&self) -> &JsValue[src]

Dereferences the value.

impl From<Array> for Object[src]

fn from(obj: Array) -> Object[src]

Performs the conversion.

impl From<ArrayBuffer> for Object[src]

fn from(obj: ArrayBuffer) -> Object[src]

Performs the conversion.

impl From<Boolean> for Object[src]

fn from(obj: Boolean) -> Object[src]

Performs the conversion.

impl From<Collator> for Object[src]

fn from(obj: Collator) -> Object[src]

Performs the conversion.

impl From<DataView> for Object[src]

fn from(obj: DataView) -> Object[src]

Performs the conversion.

impl From<Date> for Object[src]

fn from(obj: Date) -> Object[src]

Performs the conversion.

impl From<DateTimeFormat> for Object[src]

fn from(obj: DateTimeFormat) -> Object[src]

Performs the conversion.

impl From<Error> for Object[src]

fn from(obj: Error) -> Object[src]

Performs the conversion.

impl From<EvalError> for Object[src]

fn from(obj: EvalError) -> Object[src]

Performs the conversion.

impl From<Float32Array> for Object[src]

fn from(obj: Float32Array) -> Object[src]

Performs the conversion.

impl From<Float64Array> for Object[src]

fn from(obj: Float64Array) -> Object[src]

Performs the conversion.

impl From<Function> for Object[src]

fn from(obj: Function) -> Object[src]

Performs the conversion.

impl From<Generator> for Object[src]

fn from(obj: Generator) -> Object[src]

Performs the conversion.

impl From<Instance> for Object[src]

fn from(obj: Instance) -> Object[src]

Performs the conversion.

impl From<Int16Array> for Object[src]

fn from(obj: Int16Array) -> Object[src]

Performs the conversion.

impl From<Int32Array> for Object[src]

fn from(obj: Int32Array) -> Object[src]

Performs the conversion.

impl From<Int8Array> for Object[src]

fn from(obj: Int8Array) -> Object[src]

Performs the conversion.

impl From<IteratorNext> for Object[src]

fn from(obj: IteratorNext) -> Object[src]

Performs the conversion.

impl From<JsString> for Object[src]

fn from(obj: JsString) -> Object[src]

Performs the conversion.

impl From<JsValue> for Object[src]

fn from(obj: JsValue) -> Object[src]

Performs the conversion.

impl From<Map> for Object[src]

fn from(obj: Map) -> Object[src]

Performs the conversion.

impl From<Memory> for Object[src]

fn from(obj: Memory) -> Object[src]

Performs the conversion.

impl From<Module> for Object[src]

fn from(obj: Module) -> Object[src]

Performs the conversion.

impl From<Number> for Object[src]

fn from(obj: Number) -> Object[src]

Performs the conversion.

impl From<NumberFormat> for Object[src]

fn from(obj: NumberFormat) -> Object[src]

Performs the conversion.

impl From<Object> for JsValue[src]

fn from(obj: Object) -> JsValue[src]

Performs the conversion.

impl From<PluralRules> for Object[src]

fn from(obj: PluralRules) -> Object[src]

Performs the conversion.

impl From<Promise> for Object[src]

fn from(obj: Promise) -> Object[src]

Performs the conversion.

impl From<RangeError> for Object[src]

fn from(obj: RangeError) -> Object[src]

Performs the conversion.

impl From<ReferenceError> for Object[src]

fn from(obj: ReferenceError) -> Object[src]

Performs the conversion.

impl From<RegExp> for Object[src]

fn from(obj: RegExp) -> Object[src]

Performs the conversion.

impl From<Set> for Object[src]

fn from(obj: Set) -> Object[src]

Performs the conversion.

impl From<SharedArrayBuffer> for Object[src]

fn from(obj: SharedArrayBuffer) -> Object[src]

Performs the conversion.

impl From<SyntaxError> for Object[src]

fn from(obj: SyntaxError) -> Object[src]

Performs the conversion.

impl From<Table> for Object[src]

fn from(obj: Table) -> Object[src]

Performs the conversion.

impl From<TypeError> for Object[src]

fn from(obj: TypeError) -> Object[src]

Performs the conversion.

impl From<Uint16Array> for Object[src]

fn from(obj: Uint16Array) -> Object[src]

Performs the conversion.

impl From<Uint32Array> for Object[src]

fn from(obj: Uint32Array) -> Object[src]

Performs the conversion.

impl From<Uint8Array> for Object[src]

fn from(obj: Uint8Array) -> Object[src]

Performs the conversion.

impl From<Uint8ClampedArray> for Object[src]

fn from(obj: Uint8ClampedArray) -> Object[src]

Performs the conversion.

impl From<UriError> for Object[src]

fn from(obj: UriError) -> Object[src]

Performs the conversion.

impl From<WeakMap> for Object[src]

fn from(obj: WeakMap) -> Object[src]

Performs the conversion.

impl From<WeakSet> for Object[src]

fn from(obj: WeakSet) -> Object[src]

Performs the conversion.

impl FromWasmAbi for Object[src]

type Abi = <JsValue as FromWasmAbi>::Abi

The wasm ABI type that this converts from when coming back out from the ABI boundary. Read more

unsafe fn from_abi(js: Self::Abi) -> Self[src]

Recover a Self from Self::Abi. Read more

impl IntoWasmAbi for Object[src]

type Abi = <JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary. Read more

fn into_abi(self) -> Self::Abi[src]

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

impl<'a> IntoWasmAbi for &'a Object[src]

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

The wasm ABI type that this converts into when crossing the ABI boundary. Read more

fn into_abi(self) -> Self::Abi[src]

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

impl JsCast for Object[src]

fn instanceof(val: &JsValue) -> bool[src]

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

fn unchecked_from_js(val: JsValue) -> Self[src]

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

fn unchecked_from_js_ref(val: &JsValue) -> &Self[src]

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

fn has_type<T>(&self) -> bool where
    T: JsCast
[src]

Test whether this JS value has a type T. Read more

fn dyn_into<T>(self) -> Result<T, Self> where
    T: JsCast
[src]

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

fn dyn_ref<T>(&self) -> Option<&T> where
    T: JsCast
[src]

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

fn unchecked_into<T>(self) -> T where
    T: JsCast
[src]

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

fn unchecked_ref<T>(&self) -> &T where
    T: JsCast
[src]

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

fn is_instance_of<T>(&self) -> bool where
    T: JsCast
[src]

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

fn is_type_of(val: &JsValue) -> bool[src]

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

impl OptionFromWasmAbi for Object[src]

fn is_none(abi: &Self::Abi) -> bool[src]

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

impl OptionIntoWasmAbi for Object[src]

fn none() -> Self::Abi[src]

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

impl<'a> OptionIntoWasmAbi for &'a Object[src]

fn none() -> Self::Abi[src]

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

impl PartialEq<Object> for Object[src]

fn eq(&self, other: &Object) -> bool[src]

This method tests for self and other values to be equal, and is used by ==. Read more

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl RefFromWasmAbi for Object[src]

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. Read more

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

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

impl WasmDescribe for Object[src]

impl Eq for Object[src]

Auto Trait Implementations

impl RefUnwindSafe for Object

impl !Send for Object

impl !Sync for Object

impl Unpin for Object

impl UnwindSafe for Object

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ReturnWasmAbi for T where
    T: IntoWasmAbi
[src]

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi

pub fn return_abi(self) -> <T as ReturnWasmAbi>::Abi[src]

Same as IntoWasmAbi::into_abi, except that it may throw and never return in the case of Err. Read more

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.