Trait rquickjs::class::JsClass

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

    const NAME: &'static str;

    // Required methods
    fn class_id() -> &'static ClassId;
    fn prototype(ctx: &Ctx<'js>) -> Result<Option<Object<'js>>, Error>;
    fn constructor(ctx: &Ctx<'js>) -> Result<Option<Constructor<'js>>, Error>;

    // Provided method
    fn function() -> Option<StaticJsFn> { ... }
}

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

Required Associated Types

type Mutable: Mutability

Can the type be mutated while a JavaScript value.

This should either be Readable or Writable.

Required Associated Constants

const NAME: &'static str

The name the constructor has in JavaScript

Required Methods

fn class_id() -> &'static ClassId

A unique id for the class.

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

Returns the class prototype,

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

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

Provided Methods

fn function() -> Option<StaticJsFn>

A possible call function.

Returning a function from this method makes any objects with this class callable as if it is a function object..

Object Safety

This trait is not object safe.

Implementors

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

const NAME: &'static str = "RustFunction"

type Mutable = Readable