Struct script::dom::bindings::callback::CallbackObject

pub struct CallbackObject {
    callback: Heap<*mut JSObject>,
    permanent_js_root: Heap<JSVal>,
    incumbent: Option<Dom<GlobalScope>>,
}

A common base class for representing IDL callback function and callback interface types.

Fields

callback: Heap<*mut JSObject>

The underlying JSObject.

permanent_js_root: Heap<JSVal>

incumbent: Option<Dom<GlobalScope>>

The “callback context”, that is, the global to use as incumbent global when calling the callback.

Looking at the WebIDL standard, it appears as though there would always be a value here, but sometimes callback functions are created by hand-waving without defining the value of the callback context, and without any JavaScript code on the stack to grab an incumbent global from.

Implementations

impl CallbackObject

fn new() -> CallbackObject

pub fn get(&self) -> *mut JSObject

unsafe fn init(&mut self, cx: JSContext, callback: *mut JSObject)

Trait Implementations

impl Default for CallbackObject

fn default() -> CallbackObject

Returns the “default value” for a type.

impl Drop for CallbackObject

fn drop(&mut self)

Executes the destructor for this type.

impl JSTraceable for CallbackObject

unsafe fn trace(&self, tracer: *mut JSTracer)

Trace self.

impl PartialEq<CallbackObject> for CallbackObject

fn eq(&self, other: &CallbackObject) -> 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.