Struct rquickjs_core::Object

#[repr(transparent)]
pub struct Object<'js>(_);

Rust representation of a javascript object.

Implementations

impl<'js> Object<'js>

pub fn new(ctx: Ctx<'js>) -> Result<Self>

Create a new javascript object

pub fn init_def<T>(&self) -> Result<()> where
    T: ObjectDef, 

Initialize an object using ObjectDef

pub fn new_def<T>(ctx: Ctx<'js>) -> Result<Self> where
    T: ObjectDef, 

Create an object using ObjectDef

pub fn get<K: IntoAtom<'js>, V: FromJs<'js>>(&self, k: K) -> Result<V>

Get a new value

pub fn contains_key<K>(&self, k: K) -> Result<bool> where
    K: IntoAtom<'js>, 

check wether the object contains a certain key.

pub fn set<K: IntoAtom<'js>, V: IntoJs<'js>>(
    &self,
    key: K,
    value: V
) -> Result<()>

Set a member of an object to a certain value

pub fn remove<K: IntoAtom<'js>>(&self, key: K) -> Result<()>

Remove a member of an object

pub fn is_empty(&self) -> bool

Check the object for empty

pub fn len(&self) -> usize

Get the number of properties

pub fn keys<K: FromAtom<'js>>(&self) -> ObjectKeysIter<'js, K>

Get own string enumerable property names of an object

pub fn own_keys<K: FromAtom<'js>>(
    &self,
    filter: Filter
) -> ObjectKeysIter<'js, K>

Get own property names of an object

pub fn props<K: FromAtom<'js>, V: FromJs<'js>>(&self) -> ObjectIter<'js, K, V>

Get own string enumerable properties of an object

pub fn own_props<K: FromAtom<'js>, V: FromJs<'js>>(
    &self,
    filter: Filter
) -> ObjectIter<'js, K, V>

Get own properties of an object

pub fn values<K: FromAtom<'js>>(&self) -> ObjectValuesIter<'js, K>

Get own string enumerable property values of an object

pub fn own_values<K: FromAtom<'js>>(
    &self,
    filter: Filter
) -> ObjectValuesIter<'js, K>

Get own property values of an object

pub fn get_prototype(&self) -> Result<Object<'js>>

Get an object prototype

pub fn set_prototype(&self, proto: &Object<'js>) -> Result<()>

Set an object prototype

pub fn is_instance_of(&self, class: impl AsRef<Value<'js>>) -> bool

Check instance of object

pub fn into_function(self) -> Option<Function<'js>>

Convert into a function

pub fn into_array(self) -> Option<Array<'js>>

Convert into an array

impl<'js> Object<'js>

pub fn as_value(&self) -> &Value<'js>

Reference to value

pub fn into_value(self) -> Value<'js>

Convert into value

pub fn from_value(value: Value<'js>) -> Result<Self>

Convert from value

impl<'js> Object<'js>

pub fn instance_of<C: ClassDef>(&self) -> bool

Available on crate feature classes only.

Check the object for instance of

pub fn into_instance<C: ClassDef>(self) -> Option<Class<'js, C>>

Available on crate feature classes only.

Convert object into instance of class

impl<'js> Object<'js>

pub fn prop<K, V, P>(&self, key: K, prop: V) -> Result<()> where
    K: IntoAtom<'js>,
    V: AsProperty<'js, P>, 

Available on crate feature properties only.

Define a property of an object

// Define readonly property without value
obj.prop("no_val", ()).unwrap();
// Define readonly property with value
obj.prop("ro_str", "Some const text").unwrap();
// Define readonly property with value and make it to be writable
obj.prop("ro_str2", Property::from("Some const text").writable()).unwrap();
// Define readonly property using getter and make it to be enumerable
obj.prop("ro_str_get", Accessor::from(|| "Some readable text").enumerable()).unwrap();
// Define readonly property using getter and setter
obj.prop("ro_str_get_set",
    Accessor::from(|| "Some text")
        .set(|new_val: String| { /* do something */ })
).unwrap();

Methods from Deref<Target = Value<'js>>

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

Try get bool from value

pub fn as_int(&self) -> Option<i32>

Try get int from value

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

Try get float from value

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

Try get any number from value

pub fn is_bool(&self) -> bool

Check if the value is a bool

pub fn is_int(&self) -> bool

Check if the value is an int

pub fn is_float(&self) -> bool

Check if the value is a float

pub fn is_number(&self) -> bool

Check if the value is an any number

pub fn is_string(&self) -> bool

Check if the value is a string

pub fn is_symbol(&self) -> bool

Check if the value is a symbol

pub fn is_object(&self) -> bool

Check if the value is an object

pub fn is_module(&self) -> bool

Check if the value is a module

pub fn is_array(&self) -> bool

Check if the value is an array

pub fn is_function(&self) -> bool

Check if the value is a function

pub fn is_error(&self) -> bool

Check if the value is an error

pub fn as_value(&self) -> &Self

Reference as value

pub fn get<T: FromJs<'js>>(&self) -> Result<T>

Convert from value to specified type

pub fn type_of(&self) -> Type

Get the type of value

pub fn type_name(&self) -> &'static str

Get the name of type

pub unsafe fn ref_string(&self) -> &String<'js>

Interprete as

Safety

You should be sure that the value already is of required type before to do it.

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

Try reinterprete as

pub unsafe fn ref_symbol(&self) -> &Symbol<'js>

Interprete as

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_symbol(&self) -> Option<&Symbol<'js>>

Try reinterprete as

pub unsafe fn ref_object(&self) -> &Object<'js>

Interprete as

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_object(&self) -> Option<&Object<'js>>

Try reinterprete as

pub unsafe fn ref_array(&self) -> &Array<'js>

Interprete as

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_array(&self) -> Option<&Array<'js>>

Try reinterprete as

pub unsafe fn ref_function(&self) -> &Function<'js>

Interprete as

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_function(&self) -> Option<&Function<'js>>

Try reinterprete as

pub unsafe fn ref_module(&self) -> &Module<'js, Evaluated>

Interprete as

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_module(&self) -> Option<&Module<'js, Evaluated>>

Try reinterprete as

Trait Implementations

impl<'js> AsRef<Object<'js>> for ArrayBuffer<'js>

fn as_ref(&self) -> &Object<'js>

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

impl<'js, C> AsRef<Object<'js>> for Class<'js, C>

fn as_ref(&self) -> &Object<'js>

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

impl<'js, T> AsRef<Object<'js>> for TypedArray<'js, T>

fn as_ref(&self) -> &Object<'js>

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

impl<'js> AsRef<Value<'js>> for Object<'js>

fn as_ref(&self) -> &Value<'js>

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

impl<'js> Clone for Object<'js>

fn clone(&self) -> Object<'js>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'js> Debug for Object<'js>

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

Formats the value using the given formatter.

impl<'js> Deref for Object<'js>

type Target = Value<'js>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'js> From<Object<'js>> for Value<'js>

fn from(value: Object<'js>) -> Self

Converts to this type from the input type.

impl<'js, K, V> FromIteratorJs<'js, (K, V)> for Object<'js> where
    K: IntoAtom<'js>,
    V: IntoJs<'js>, 

type Item = (Atom<'js>, Value<'js>)

fn from_iter_js<T>(ctx: Ctx<'js>, iter: T) -> Result<Self> where
    T: IntoIterator<Item = (K, V)>, 

impl<'js> FromJs<'js> for Object<'js>

fn from_js(_: Ctx<'js>, value: Value<'js>) -> Result<Self>

impl<'js> IntoAtom<'js> for Object<'js>

fn into_atom(self, ctx: Ctx<'js>) -> Atom<'js>

impl<'js> IntoIterator for Object<'js>

type Item = Result<(Atom<'js>, Value<'js>), Error>

The type of the elements being iterated over.

type IntoIter = ObjectIter<'js, Atom<'js>, Value<'js>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'js> IntoJs<'js> for Object<'js>

fn into_js(self, _: Ctx<'js>) -> Result<Value<'js>>

impl<'js, 't> Outlive<'t> for Object<'js>

type Target = Object<'t>

The target which has the same type as a Self but with another lifetime 't

impl<'js> PartialEq<Object<'js>> for Object<'js>

fn eq(&self, other: &Object<'js>) -> bool

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

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

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

impl<'js> StructuralPartialEq for Object<'js>