Struct script::dom::messageport::MessagePort
source · #[repr(C)]pub struct MessagePort {
eventtarget: EventTarget,
message_port_id: MessagePortId,
entangled_port: RefCell<Option<MessagePortId>>,
detached: Cell<bool>,
}
Expand description
The MessagePort used in the DOM.
Fields
eventtarget: EventTarget
message_port_id: MessagePortId
entangled_port: RefCell<Option<MessagePortId>>
detached: Cell<bool>
Implementations
sourceimpl MessagePort
impl MessagePort
fn __assert_parent_type(&self)
sourceimpl MessagePort
impl MessagePort
fn new_inherited(message_port_id: MessagePortId) -> MessagePort
sourcepub fn new(owner: &GlobalScope) -> Root<Dom<MessagePort>>
pub fn new(owner: &GlobalScope) -> Root<Dom<MessagePort>>
sourcefn new_transferred(
owner: &GlobalScope,
transferred_port: MessagePortId,
entangled_port: Option<MessagePortId>
) -> Root<Dom<MessagePort>>
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.
sourcepub fn entangle(&self, other_id: MessagePortId)
pub fn entangle(&self, other_id: MessagePortId)
pub fn message_port_id(&self) -> &MessagePortId
pub fn detached(&self) -> bool
sourcefn set_onmessage(&self, listener: Option<Rc<EventHandlerNonNull>>)
fn set_onmessage(&self, listener: Option<Rc<EventHandlerNonNull>>)
sourcefn post_message_impl(
&self,
cx: SafeJSContext,
message: HandleValue<'_>,
transfer: CustomAutoRooterGuard<'_, Vec<*mut JSObject>>
) -> Result<(), Error>
fn post_message_impl(
&self,
cx: SafeJSContext,
message: HandleValue<'_>,
transfer: CustomAutoRooterGuard<'_, Vec<*mut JSObject>>
) -> Result<(), Error>
Trait Implementations
sourceimpl Castable for MessagePort
impl Castable for MessagePort
sourcefn is<T>(&self) -> boolwhere
T: DerivedFrom<Self>,
fn is<T>(&self) -> boolwhere
T: DerivedFrom<Self>,
Check whether a DOM object implements one of its deriving interfaces.
sourcefn upcast<T>(&self) -> &Twhere
T: Castable,
Self: DerivedFrom<T>,
fn upcast<T>(&self) -> &Twhere
T: Castable,
Self: DerivedFrom<T>,
Cast a DOM object upwards to one of the interfaces it derives from.
sourcefn downcast<T>(&self) -> Option<&T>where
T: DerivedFrom<Self>,
fn downcast<T>(&self) -> Option<&T>where
T: DerivedFrom<Self>,
Cast a DOM object downwards to one of the interfaces it might implement.
sourceimpl DomObject for MessagePort
impl DomObject for MessagePort
sourceimpl DomObjectWrap for MessagePort
impl DomObjectWrap for MessagePort
sourceconst WRAP: unsafe fn(_: SafeJSContext, _: &GlobalScope, _: Box<Self>) -> Root<Dom<Self>> = {dom::bindings::codegen::Bindings::MessagePortBinding::MessagePortBinding::Wrap as for<'a> unsafe fn(script_runtime::JSContext, &'a dom::globalscope::GlobalScope, std::boxed::Box<dom::messageport::MessagePort>) -> dom::bindings::root::Root<dom::bindings::root::Dom<dom::messageport::MessagePort>>}
const WRAP: unsafe fn(_: SafeJSContext, _: &GlobalScope, _: Box<Self>) -> Root<Dom<Self>> = {dom::bindings::codegen::Bindings::MessagePortBinding::MessagePortBinding::Wrap as for<'a> unsafe fn(script_runtime::JSContext, &'a dom::globalscope::GlobalScope, 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
sourceimpl HasParent for MessagePort
impl HasParent for MessagePort
sourcefn as_parent(&self) -> &EventTarget
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
sourceimpl IDLInterface for MessagePort
impl IDLInterface for MessagePort
sourceimpl JSTraceable for MessagePort
impl JSTraceable for MessagePort
sourceimpl MallocSizeOf for MessagePort
impl MallocSizeOf for MessagePort
sourcefn size_of(&self, ops: &mut MallocSizeOfOps) -> usize
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. Read more
sourceimpl MessagePortMethods for MessagePort
impl MessagePortMethods for MessagePort
sourcefn PostMessage(
&self,
cx: SafeJSContext,
message: HandleValue<'_>,
transfer: CustomAutoRooterGuard<'_, Vec<*mut JSObject>>
) -> Result<(), Error>
fn PostMessage(
&self,
cx: SafeJSContext,
message: HandleValue<'_>,
transfer: CustomAutoRooterGuard<'_, Vec<*mut JSObject>>
) -> Result<(), Error>
sourcefn PostMessage_(
&self,
cx: SafeJSContext,
message: HandleValue<'_>,
options: RootedTraceableBox<PostMessageOptions>
) -> Result<(), Error>
fn PostMessage_(
&self,
cx: SafeJSContext,
message: HandleValue<'_>,
options: RootedTraceableBox<PostMessageOptions>
) -> Result<(), Error>
sourcefn GetOnmessage(&self) -> Option<Rc<EventHandlerNonNull>>
fn GetOnmessage(&self) -> Option<Rc<EventHandlerNonNull>>
sourcefn SetOnmessage(&self, listener: Option<Rc<EventHandlerNonNull>>)
fn SetOnmessage(&self, listener: Option<Rc<EventHandlerNonNull>>)
fn GetOnmessageerror(&self) -> Option<Rc<EventHandlerNonNull>>
fn SetOnmessageerror(&self, listener: Option<Rc<EventHandlerNonNull>>)
sourceimpl MutDomObject for MessagePort
impl MutDomObject for MessagePort
sourceunsafe fn init_reflector(&self, obj: *mut JSObject)
unsafe fn init_reflector(&self, obj: *mut JSObject)
Initializes the Reflector
sourceimpl PartialEq<MessagePort> for MessagePort
impl PartialEq<MessagePort> for MessagePort
sourcefn eq(&self, other: &MessagePort) -> bool
fn eq(&self, other: &MessagePort) -> bool
sourceimpl ToJSValConvertible for MessagePort
impl ToJSValConvertible for MessagePort
sourceunsafe fn to_jsval(&self, cx: *mut JSContext, rval: MutableHandleValue<'_>)
unsafe fn to_jsval(&self, cx: *mut JSContext, rval: MutableHandleValue<'_>)
Convert
self
to a JSVal
. JSAPI failure causes a panic.sourceimpl Transferable for MessagePort
impl Transferable for MessagePort
sourcefn transfer_receive(
owner: &GlobalScope,
sc_holder: &mut StructuredDataHolder,
extra_data: u64,
return_object: MutableHandleObject
) -> Result<(), ()>
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
sourceimpl WeakReferenceable for MessagePort
impl WeakReferenceable for MessagePort
impl DerivedFrom<EventTarget> for MessagePort
Auto Trait Implementations
impl !RefUnwindSafe for MessagePort
impl !Send for MessagePort
impl !Sync for MessagePort
impl Unpin for MessagePort
impl !UnwindSafe for MessagePort
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> MaybeBoxed<Box<T, Global>> for T
impl<T> MaybeBoxed<Box<T, Global>> for T
sourcefn maybe_boxed(self) -> Box<T, Global>
fn maybe_boxed(self) -> Box<T, Global>
Convert
sourceimpl<T> MaybeBoxed<T> for T
impl<T> MaybeBoxed<T> for T
sourcefn maybe_boxed(self) -> T
fn maybe_boxed(self) -> T
Convert