Struct script_traits::transferable::MessagePortImpl

pub struct MessagePortImpl {
    state: MessagePortState,
    entangled_port: Option<MessagePortId>,
    message_buffer: Option<VecDeque<PortMessageTask>>,
    message_port_id: MessagePortId,
}

The data and logic backing the DOM managed MessagePort.

Fields

state: MessagePortState

The current state of the port.

entangled_port: Option<MessagePortId>

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

message_buffer: Option<VecDeque<PortMessageTask>>

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

message_port_id: MessagePortId

The UUID of this port.

Implementations

impl MessagePortImpl

pub fn new(port_id: MessagePortId) -> MessagePortImpl

Create a new messageport impl.

pub fn message_port_id(&self) -> &MessagePortId

Get the Id.

pub fn entangled_port_id(&self) -> Option<MessagePortId>

Maybe get the Id of the entangled port.

pub fn entangle(&mut self, other_id: MessagePortId)

Entanged this port with another.

pub fn enabled(&self) -> bool

Is this port enabled?

pub fn set_has_been_shipped(&mut self)

Mark this port as having been shipped. https://html.spec.whatwg.org/multipage/#has-been-shipped

pub fn complete_transfer(&mut self, tasks: VecDeque<PortMessageTask>)

Handle the completion of the transfer, this is data received from the constellation.

pub fn handle_incoming( &mut self, task: PortMessageTask, ) -> Option<PortMessageTask>

A message was received from our entangled port, returns an optional task to be dispatched.

pub fn start(&mut self) -> Option<VecDeque<PortMessageTask>>

https://html.spec.whatwg.org/multipage/#dom-messageport-start returns an optional queue of tasks that were buffered while the port was disabled.

pub fn close(&mut self)

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

Trait Implementations

impl Debug for MessagePortImpl

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MessagePortImpl

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl MallocSizeOf for MessagePortImpl

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 Serialize for MessagePortImpl

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.