Struct script::dom::promise::Promise

#[repr(C)]
pub struct Promise {
    reflector: Reflector,
    permanent_js_root: Heap<JSVal>,
}

Fields

reflector: Reflector

permanent_js_root: Heap<JSVal>

Since Promise values are natively reference counted without the knowledge of the SpiderMonkey GC, an explicit root for the reflector is stored while any native instance exists. This ensures that the reflector will never be GCed while native code could still interact with its native representation.

Implementations

impl Promise

pub fn new(global: &GlobalScope) -> Rc<Promise>

pub fn new_in_current_realm(_comp: InRealm<'_>) -> Rc<Promise>

pub fn duplicate(&self) -> Rc<Promise>

pub fn new_with_js_promise(
    obj: HandleObject<'_>,
    cx: SafeJSContext
) -> Rc<Promise>

fn create_js_promise(cx: SafeJSContext, obj: MutableHandleObject<'_>)

pub fn new_resolved(
    global: &GlobalScope,
    cx: SafeJSContext,
    value: HandleValue<'_>
) -> Result<Rc<Promise>, Error>

pub fn new_rejected(
    global: &GlobalScope,
    cx: SafeJSContext,
    value: HandleValue<'_>
) -> Result<Rc<Promise>, Error>

pub fn resolve_native<T>(&self, val: &T)where
    T: ToJSValConvertible,

pub fn resolve(&self, cx: SafeJSContext, value: HandleValue<'_>)

pub fn reject_native<T>(&self, val: &T)where
    T: ToJSValConvertible,

pub fn reject_error(&self, error: Error)

pub fn reject(&self, cx: SafeJSContext, value: HandleValue<'_>)

pub fn is_fulfilled(&self) -> bool

pub fn promise_obj(&self) -> HandleObject<'_>

pub fn append_native_handler(
    &self,
    handler: &PromiseNativeHandler,
    _comp: InRealm<'_>
)

Trait Implementations

impl DomObject for Promise

fn reflector(&self) -> &Reflector

Returns the receiver’s reflector.

fn global(&self) -> Root<Dom<GlobalScope>>where
    Self: Sized,

Returns the global scope of the realm that the DomObject was created in.

impl Drop for Promise

fn drop(&mut self)

Executes the destructor for this type.

impl HasParent for Promise

fn as_parent(&self) -> &Reflector

This is used in a type assertion to ensure that the source and webidls agree as to what the parent type is

type Parent = Reflector

impl JSTraceable for Promise

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

Trace self.

impl MallocSizeOf for Promise

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl MutDomObject for Promise

unsafe fn init_reflector(&self, obj: *mut JSObject)

Initializes the Reflector

impl ToJSValConvertible for Promise

unsafe fn to_jsval(&self, cx: *mut JSContext, rval: MutableHandleValue<'_>)

Convert self to a JSVal. JSAPI failure causes a panic.