Struct Object 

pub struct Object<'o> {
    obj: Local<'o, *mut JSObject>,
}

Represents an Object in the JS Runtime.

Refer to MDN for more details.

Fields

obj: Local<'o, *mut JSObject>

Implementations

impl<'o> Object<'o>

pub fn new(cx: &'o Context) -> Object<'o>

Creates a plain empty Object.

pub fn null(cx: &'o Context) -> Object<'o>

Creates a null “Object”.

Most operations on this will result in an error, so be wary of where it is used.

pub fn global(cx: &'o Context) -> Object<'o>

Returns the current global object or null if one has not been initialised yet.

pub fn has<'cx, K: ToPropertyKey<'cx>>(&self, cx: &'cx Context, key: K) -> bool

Checks if the Object has a value at the given key.

pub fn has_own<'cx, K: ToPropertyKey<'cx>>( &self, cx: &'cx Context, key: K, ) -> bool

Checks if the Object has its own value at the given key.

An object owns its properties if they are not inherited from a prototype.

pub fn get<'cx, K: ToPropertyKey<'cx>>( &self, cx: &'cx Context, key: K, ) -> Result<Option<Value<'cx>>>

Gets the Value at the given key of the Object.

Returns None if there is no value at the given key.

pub fn get_as<'cx, K: ToPropertyKey<'cx>, T: FromValue<'cx>>( &self, cx: &'cx Context, key: K, strict: bool, config: T::Config, ) -> Result<Option<T>>

Gets the value at the given key of the Object. as a Rust type. Returns None if the object does not contain the key or conversion to the Rust type fails.

pub fn get_descriptor<'cx, K: ToPropertyKey<'cx>>( &self, cx: &'cx Context, key: K, ) -> Result<Option<PropertyDescriptor<'cx>>>

Gets the descriptor at the given key of the Object. Returns None if the object does not contain the key.

pub fn set<'cx, K: ToPropertyKey<'cx>>( &self, cx: &'cx Context, key: K, value: &Value<'_>, ) -> bool

Sets the Value at the given key of the Object.

Returns false if the property cannot be set.

pub fn set_as<'cx, K: ToPropertyKey<'cx>, T: ToValue<'cx> + ?Sized>( &self, cx: &'cx Context, key: K, value: &T, ) -> bool

Sets the Rust type at the given key of the Object.

Returns false if the property cannot be set.

pub fn define<'cx, K: ToPropertyKey<'cx>>( &self, cx: &'cx Context, key: K, value: &Value<'_>, attrs: PropertyFlags, ) -> bool

Defines the Value at the given key of the Object with the given attributes.

Returns false if the property cannot be defined.

pub fn define_as<'cx, K: ToPropertyKey<'cx>, T: ToValue<'cx> + ?Sized>( &self, cx: &'cx Context, key: K, value: &T, attrs: PropertyFlags, ) -> bool

Defines the Rust type at the given key of the Object with the given attributes.

Returns false if the property cannot be defined.

pub fn define_method<'cx, K: ToPropertyKey<'cx>>( &self, cx: &'cx Context, key: K, method: NativeFunction, nargs: u32, attrs: PropertyFlags, ) -> Function<'cx>

Defines a method with the given name, and the given number of arguments and attributes on the Object.

Parameters are similar to create_function_spec.

pub unsafe fn define_methods( &self, cx: &Context, methods: &[JSFunctionSpec], ) -> bool

Defines methods on the objects using the given specs.

The final element of the methods slice must be JSFunctionSpec::ZERO. They can be created through function_spec.

pub unsafe fn define_methods_with_help( &self, cx: &Context, methods: &[JSFunctionSpecWithHelp], ) -> bool

Defines methods on the objects using the given specs, with help.

The final element of the methods slice must be JSFunctionSpecWithHelp::ZERO.

pub unsafe fn define_properties( &self, cx: &Context, properties: &[JSPropertySpec], ) -> bool

Defines properties on the object using the given specs.

The final element of the properties slice must be JSPropertySpec::ZERO.

pub fn delete<'cx, K: ToPropertyKey<'cx>>( &self, cx: &'cx Context, key: K, ) -> bool

Deletes the Value at the given index.

Returns false if the element cannot be deleted.

pub fn get_builtin_class(&self, cx: &Context) -> ESClass

Gets the builtin class of the object as described in the ECMAScript specification.

Returns ESClass::Other for other projects or proxies that cannot be unwrapped.

pub fn is_boxed_primitive(&self, cx: &Context) -> Option<ESClass>

Returns the builtin class of the object if it a wrapper around a primitive.

The boxed types are Boolean, Number, String and BigInt

pub fn unbox_primitive<'cx>(&self, cx: &'cx Context) -> Option<Value<'cx>>

Unboxes primitive wrappers. See Object::is_boxed_primitive for details.

pub fn keys<'cx>( &self, cx: &'cx Context, flags: Option<IteratorFlags>, ) -> ObjectKeysIter<'cx>

Returns an iterator of the keys of the Object. Each key can be a String, Symbol or integer.

pub fn iter<'cx, 's>( &'s self, cx: &'cx Context, flags: Option<IteratorFlags>, ) -> ObjectIter<'cx, 's>

where 'o: 'cx,

pub fn to_hashmap<'cx>( &self, cx: &'cx Context, flags: Option<IteratorFlags>, ) -> Result<HashMap<OwnedKey<'cx>, Value<'cx>>>

where 'o: 'cx,

pub fn into_local(self) -> Local<'o, *mut JSObject>

Methods from Deref<Target = Local<'o, *mut JSObject>>

pub fn handle(&self) -> Handle<'local, T>

Forms a Handle to the Local which can be passed to SpiderMonkey APIs.

pub fn handle_mut(&mut self) -> MutableHandle<'local, T>

Forms a Handle to the Local which can be passed to SpiderMonkey APIs.

Panics

Panics when a Local::Handle is passed.

pub fn get(&self) -> T

Trait Implementations

impl<'o> Debug for Object<'o>

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

Formats the value using the given formatter.

impl<'o> Deref for Object<'o>

type Target = Local<'o, *mut JSObject>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Object<'_>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'o> From<Local<'o, *mut JSObject>> for Object<'o>

fn from(obj: Local<'o, *mut JSObject>) -> Object<'o>

Converts to this type from the input type.

impl<'cx> FromValue<'cx> for Object<'cx>

type Config = ()

fn from_value( cx: &'cx Context, value: &Value<'_>, _: bool, _: (), ) -> Result<Object<'cx>>

Converts value to the desired type. strict and config determine the strictness of the conversion and specify additional conversion constraints respectively. Returns Err with the error if conversion fails.

impl<'cx> ToValue<'cx> for Object<'cx>

fn to_value(&self, cx: &'cx Context, value: &mut Value<'_>)

Converts self to a Value and stores it in value.

fn as_value(&self, cx: &'cx Context) -> Value<'cx>

Converts self to a new Value.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 16 bytes