Struct MessagePortProxy

pub struct MessagePortProxy { /* private fields */ }

Implementations

impl MessagePortProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.web/MessagePort.

pub fn take_event_stream(&self) -> MessagePortEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn post_message( &self, message: WebMessage, ) -> QueryResponseFut<MessagePortPostMessageResult, DefaultFuchsiaResourceDialect>

Sends a WebMessage to the peer. These are processed in order, one at a time. It is not necessary for the caller to wait for the completion callback before calling [MessagePort.PostMessage] again.

If an error occurred, the FrameError will be set to one of these value:

• BUFFER_NOT_UTF8: The script in message’s data property is not UTF-8 encoded.
• NO_DATA_IN_MESSAGE: The data property is missing in message.

pub fn receive_message( &self, ) -> QueryResponseFut<WebMessage, DefaultFuchsiaResourceDialect>

Asynchronously reads the next message from the channel. The client should invoke the callback when it is ready to process another message. Unreceived messages are buffered on the sender’s side and bounded by its available resources.

Trait Implementations

impl Clone for MessagePortProxy

fn clone(&self) -> MessagePortProxy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MessagePortProxy

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

Formats the value using the given formatter.

impl MessagePortProxyInterface for MessagePortProxy

type PostMessageResponseFut = QueryResponseFut<Result<(), FrameError>>

type ReceiveMessageResponseFut = QueryResponseFut<WebMessage>

fn post_message(&self, message: WebMessage) -> Self::PostMessageResponseFut

fn receive_message(&self) -> Self::ReceiveMessageResponseFut

impl Proxy for MessagePortProxy

type Protocol = MessagePortMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.