Struct rquickjs_core::Class

pub struct Class<'js, C>(_, _);

Available on crate feature classes only.

The class object interface

Implementations

impl<'js, C> Class<'js, C> where
    C: ClassDef, 

pub fn constructor<F>(func: F) -> Constructor<C, F>

Wrap constructor of class

pub fn static_init(ctx: Ctx<'js>, func: &Function<'js>) -> Result<()>

Initialize static data

pub fn instance(ctx: Ctx<'js>, value: C) -> Result<Class<'js, C>>

Instantiate the object of class

pub fn instance_proto(
    ctx: Ctx<'js>,
    value: C,
    proto: Object<'js>
) -> Result<Class<'js, C>>

Instantiate the object of class with given prototype

pub fn try_ref<'r>(ctx: Ctx<'js>, value: &Object<'js>) -> Result<&'r C>

Get reference from object

pub fn try_mut<'r>(ctx: Ctx<'js>, value: &Object<'js>) -> Result<&'r mut C>

Get mutable reference from object

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

Register the class

pub unsafe fn register_raw(ctx: *mut JSContext)

Register the class using raw context

Safety

This function must only be called from js_module_init function or should be called right after context initialization. From Rust code you should use Class::register instead.

pub fn prototype(ctx: Ctx<'js>) -> Result<Object<'js>>

Get the own prototype object of a class

pub fn from_object(value: Object<'js>) -> Result<Self>

Get class from value

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

Get reference to object

pub fn into_object(self) -> Object<'js>

Convert to object

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

Convert to value

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

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

Initialize 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 as_value(&self) -> &Value<'js>

Reference to value

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

Check the object for instance of

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, C> AsMut<C> for Class<'js, C> where
    C: ClassDef, 

fn as_mut(&mut self) -> &mut C

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

impl<'js, C> AsRef<C> for Class<'js, C> where
    C: ClassDef, 

fn as_ref(&self) -> &C

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, C> AsRef<Value<'js>> for Class<'js, C>

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

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

impl<'js, C> Deref for Class<'js, C>

type Target = Object<'js>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'js, C> FromJs<'js> for Class<'js, C> where
    C: ClassDef, 

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

impl<'js, C> IntoJs<'js> for Class<'js, C> where
    C: ClassDef, 

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

impl<'js, 't, C> Outlive<'t> for Class<'js, C>

type Target = Class<'t, C>

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