Struct script::dom::messageport::MessagePort

#[repr(C)]
pub struct MessagePort {
    eventtarget: EventTarget,
    message_port_id: MessagePortId,
    entangled_port: RefCell<Option<MessagePortId>>,
    detached: Cell<bool>,
}

The MessagePort used in the DOM.

Fields

eventtarget: EventTarget

message_port_id: MessagePortId

entangled_port: RefCell<Option<MessagePortId>>

detached: Cell<bool>

Implementations

impl MessagePort

fn __assert_parent_type(&self)

impl MessagePort

fn new_inherited(message_port_id: MessagePortId) -> MessagePort

pub fn new(owner: &GlobalScope) -> Root<Dom<MessagePort>>

https://html.spec.whatwg.org/multipage/#create-a-new-messageport-object

fn new_transferred(
    owner: &GlobalScope,
    transferred_port: MessagePortId,
    entangled_port: Option<MessagePortId>
) -> Root<Dom<MessagePort>>

Create a new port for an incoming transfer-received one.

pub fn entangle(&self, other_id: MessagePortId)

https://html.spec.whatwg.org/multipage/#entangle

pub fn message_port_id(&self) -> &MessagePortId

pub fn detached(&self) -> bool

fn set_onmessage(&self, listener: Option<Rc<EventHandlerNonNull>>)

https://html.spec.whatwg.org/multipage/#handler-messageport-onmessage

fn post_message_impl(
    &self,
    cx: SafeJSContext,
    message: HandleValue<'_>,
    transfer: CustomAutoRooterGuard<'_, Vec<*mut JSObject>>
) -> Result<(), Error>

https://html.spec.whatwg.org/multipage/#message-port-post-message-steps

Trait Implementations

impl Castable for MessagePort

fn is<T>(&self) -> boolwhere
    T: DerivedFrom<Self>,

Check whether a DOM object implements one of its deriving interfaces.

fn upcast<T>(&self) -> &Twhere
    T: Castable,
    Self: DerivedFrom<T>,

Cast a DOM object upwards to one of the interfaces it derives from.

fn downcast<T>(&self) -> Option<&T>where
    T: DerivedFrom<Self>,

Cast a DOM object downwards to one of the interfaces it might implement.

impl DomObject for MessagePort

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 DomObjectWrap for MessagePort

const WRAP: unsafe fn(_: SafeJSContext, _: &GlobalScope, _: Option<HandleObject<'_>>, _: Box<Self>) -> Root<Dom<Self>> = {dom::bindings::codegen::Bindings::MessagePortBinding::MessagePortBinding::Wrap as for<'a, 'b> unsafe fn(script_runtime::JSContext, &'a dom::globalscope::GlobalScope, std::option::Option<js::rust::Handle<'b, *mut js::jsapi::JSObject>>, std::boxed::Box<dom::messageport::MessagePort>) -> dom::bindings::root::Root<dom::bindings::root::Dom<dom::messageport::MessagePort>>}

Function pointer to the general wrap function type

impl HasParent for MessagePort

fn as_parent(&self) -> &EventTarget

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

type Parent = EventTarget

impl IDLInterface for MessagePort

fn derives(class: &'static DOMClass) -> bool

Returns whether the given DOM class derives that interface.

impl MallocSizeOf for MessagePort

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 MessagePortMethods for MessagePort

fn PostMessage(
    &self,
    cx: SafeJSContext,
    message: HandleValue<'_>,
    transfer: CustomAutoRooterGuard<'_, Vec<*mut JSObject>>
) -> Result<(), Error>

https://html.spec.whatwg.org/multipage/#dom-messageport-postmessage

fn PostMessage_(
    &self,
    cx: SafeJSContext,
    message: HandleValue<'_>,
    options: RootedTraceableBox<PostMessageOptions>
) -> Result<(), Error>

https://html.spec.whatwg.org/multipage/#dom-messageport-postmessage

fn Start(&self)

https://html.spec.whatwg.org/multipage/#dom-messageport-start

fn Close(&self)

https://html.spec.whatwg.org/multipage/#dom-messageport-close

fn GetOnmessage(&self) -> Option<Rc<EventHandlerNonNull>>

https://html.spec.whatwg.org/multipage/#handler-messageport-onmessage

fn SetOnmessage(&self, listener: Option<Rc<EventHandlerNonNull>>)

https://html.spec.whatwg.org/multipage/#handler-messageport-onmessage

fn GetOnmessageerror(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOnmessageerror(&self, listener: Option<Rc<EventHandlerNonNull>>)

impl MutDomObject for MessagePort

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

Initializes the Reflector

impl PartialEq<MessagePort> for MessagePort

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

impl ToJSValConvertible for MessagePort

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

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

impl Traceable for MessagePort

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

Trace self.

impl Transferable for MessagePort

fn transfer(&self, sc_holder: &mut StructuredDataHolder) -> Result<u64, ()>

https://html.spec.whatwg.org/multipage/#message-ports:transfer-steps

fn transfer_receive(
    owner: &GlobalScope,
    sc_holder: &mut StructuredDataHolder,
    extra_data: u64,
    return_object: MutableHandleObject
) -> Result<(), ()>

https://html.spec.whatwg.org/multipage/#message-ports:transfer-receiving-steps

impl WeakReferenceable for MessagePort

fn downgrade(&self) -> WeakRef<Self>

Downgrade a DOM object reference to a weak one.

impl DerivedFrom<EventTarget> for MessagePort