Trait JsClass 

pub trait JsClass<'js>:
    Trace<'js>
    + JsLifetime<'js>
    + Sized {
    type Mutable: Mutability;

    const NAME: &'static str;
    const KIND: ClassKind = ClassKind::Plain;

    // Required method
    fn constructor(ctx: &Ctx<'js>) -> Result<Option<Constructor<'js>>>;

    // Provided methods
    fn prototype(ctx: &Ctx<'js>) -> Result<Option<Object<'js>>> { ... }
    fn call<'a>(
        this: &JsCell<'js, Self>,
        params: Params<'a, 'js>,
    ) -> Result<Value<'js>> { ... }
    fn exotic_get_property(
        this: &JsCell<'js, Self>,
        ctx: &Ctx<'js>,
        _atom: Atom<'js>,
        _receiver: Value<'js>,
    ) -> Result<Value<'js>> { ... }
    fn exotic_set_property(
        this: &JsCell<'js, Self>,
        _ctx: &Ctx<'js>,
        _atom: Atom<'js>,
        _receiver: Value<'js>,
        _value: Value<'js>,
    ) -> Result<bool> { ... }
    fn exotic_delete_property(
        this: &JsCell<'js, Self>,
        _ctx: &Ctx<'js>,
        _atom: Atom<'js>,
    ) -> Result<bool> { ... }
    fn exotic_has_property(
        this: &JsCell<'js, Self>,
        _ctx: &Ctx<'js>,
        _atom: Atom<'js>,
    ) -> Result<bool> { ... }
    fn exotic_get_own_property(
        this: &JsCell<'js, Self>,
        _ctx: &Ctx<'js>,
        _atom: Atom<'js>,
    ) -> Result<Option<PropertyDescriptor<'js>>> { ... }
    fn exotic_get_own_property_names(
        this: &JsCell<'js, Self>,
        _ctx: &Ctx<'js>,
    ) -> Result<Vec<PropertyName<'js>>> { ... }
}

The trait which allows Rust types to be used from JavaScript.

Required Associated Constants

const NAME: &'static str

The name the constructor has in JavaScript

Provided Associated Constants

const KIND: ClassKind = ClassKind::Plain

The kind of this class (plain, callable, or exotic).

Required Associated Types

type Mutable: Mutability

Can the type be mutated while a JavaScript value.

This should either be Readable or Writable.

Required Methods

fn constructor(ctx: &Ctx<'js>) -> Result<Option<Constructor<'js>>>

Returns a predefined constructor for this specific class type if there is one.

Provided Methods

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

Returns the class prototype,

fn call<'a>( this: &JsCell<'js, Self>, params: Params<'a, 'js>, ) -> Result<Value<'js>>

The function which will be called if Self::KIND is ClassKind::Callable and an object with this class is called as if it is a function.

fn exotic_get_property( this: &JsCell<'js, Self>, ctx: &Ctx<'js>, _atom: Atom<'js>, _receiver: Value<'js>, ) -> Result<Value<'js>>

The function which will be called if a get property is performed on an object with this class

fn exotic_set_property( this: &JsCell<'js, Self>, _ctx: &Ctx<'js>, _atom: Atom<'js>, _receiver: Value<'js>, _value: Value<'js>, ) -> Result<bool>

The function which will be called if a set property is performed on an object with this class

fn exotic_delete_property( this: &JsCell<'js, Self>, _ctx: &Ctx<'js>, _atom: Atom<'js>, ) -> Result<bool>

The function which will be called if a delete property is performed on an object with this class

fn exotic_has_property( this: &JsCell<'js, Self>, _ctx: &Ctx<'js>, _atom: Atom<'js>, ) -> Result<bool>

The function which will be called if has property or similar is called on an object with this class

fn exotic_get_own_property( this: &JsCell<'js, Self>, _ctx: &Ctx<'js>, _atom: Atom<'js>, ) -> Result<Option<PropertyDescriptor<'js>>>

Called to get the own property descriptor for a given property name.

Return Ok(Some(descriptor)) if the property exists, Ok(None) if it doesn’t.

fn exotic_get_own_property_names( this: &JsCell<'js, Self>, _ctx: &Ctx<'js>, ) -> Result<Vec<PropertyName<'js>>>

Called to enumerate the own property names of this object.

Return a list of property names.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl<'js> JsClass<'js> for RustFunction<'js>

const NAME: &'static str = "RustFunction"

const KIND: ClassKind = ClassKind::Callable

type Mutable = Readable