Struct rquickjs_core::Object[−][src]

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

Rust representation of a javascript object.

Implementations

`impl<'js> Object<'js>`[src]

`pub fn new(ctx: Ctx<'js>) -> Result<Self>`[src]

Create a new javascript object

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

Initialize an object using ObjectDef

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

Create an object using ObjectDef

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

Get a new value

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

check wether the object contains a certain key.

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

Set a member of an object to a certain value

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

Remove a member of an object

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

Check the object for empty

`pub fn len(&self) -> usize`[src]

Get the number of properties

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

Get own string enumerable property names of an object

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

Get own property names of an object

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

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

Get own properties of an object

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

Get own string enumerable property values of an object

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

Get own property values of an object

`pub fn get_prototype(&self) -> Result<Object<'js>>`[src]

Get an object prototype

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

Set an object prototype

`pub fn into_function(self) -> Option<Function<'js>>`[src]

Convert into a function

`pub fn into_array(self) -> Option<Array<'js>>`[src]

Convert into an array

`impl<'js> Object<'js>`[src]

`pub fn as_value(&self) -> &Value<'js>`[src]

Reference to value

`pub fn into_value(self) -> Value<'js>`[src]

Convert into value

`pub fn from_value(value: Value<'js>) -> Result<Self>`[src]

Convert from value

`impl<'js> Object<'js>`[src]

`pub fn instance_of<C: ClassDef>(&self) -> bool`[src]

This is supported on crate feature classes only.

Check the object for instance of

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

This is supported on crate feature classes only.

Convert object into instance of class

`impl<'js> Object<'js>`[src]

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

This is supported 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>`[src]

Try get bool from value

`pub fn as_int(&self) -> Option<i32>`[src]

Try get int from value

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

Try get float from value

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

Try get any number from value

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

Check if the value is a bool

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

Check if the value is an int

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

Check if the value is a float

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

Check if the value is an any number

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

Check if the value is a string

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

Check if the value is a symbol

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

Check if the value is an object

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

Check if the value is a module

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

Check if the value is an array

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

Check if the value is a function

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

Check if the value is an error

`pub fn as_value(&self) -> &Self`[src]

Reference as value

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

Convert from value to specified type

`pub fn type_of(&self) -> Type`[src]

Get the type of value

`pub fn type_name(&self) -> &'static str`[src]

Get the name of type