Struct SimpleStreamSinkSynchronousProxy 

pub struct SimpleStreamSinkSynchronousProxy { /* private fields */ }

Implementations

impl SimpleStreamSinkSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<SimpleStreamSinkEvent, Error>

Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.

pub fn add_payload_buffer( &self, id: u32, payload_buffer: Vmo, ) -> Result<(), Error>

Adds a payload buffer to the current buffer set associated with the connection. A StreamPacket struct reference a payload buffer in the current set by ID using the StreamPacket.payload_buffer_id field.

A buffer with ID id must not be in the current set when this method is invoked, otherwise the service will close the connection.

pub fn remove_payload_buffer(&self, id: u32) -> Result<(), Error>

Removes a payload buffer from the current buffer set associated with the connection.

A buffer with ID id must exist in the current set when this method is invoked, otherwise the service will will close the connection.

pub fn send_packet( &self, packet: &StreamPacket, ___deadline: MonotonicInstant, ) -> Result<(), Error>

Sends a packet to the service. The response is sent when the service is done with the associated payload memory.

packet must be valid for the current buffer set, otherwise the service will close the connection.

pub fn send_packet_no_reply(&self, packet: &StreamPacket) -> Result<(), Error>

Sends a packet to the service. This interface doesn’t define how the client knows when the sink is done with the associated payload memory. The inheriting interface must define that.

packet must be valid for the current buffer set, otherwise the service will close the connection.

pub fn end_of_stream(&self) -> Result<(), Error>

Indicates the stream has ended. The precise semantics of this method are determined by the inheriting interface.

pub fn discard_all_packets( &self, ___deadline: MonotonicInstant, ) -> Result<(), Error>

Discards packets previously sent via SendPacket or SendPacketNoReply and not yet released. The response is sent after all packets have been released.

pub fn discard_all_packets_no_reply(&self) -> Result<(), Error>

Discards packets previously sent via SendPacket or SendPacketNoReply and not yet released.

Trait Implementations

impl Debug for SimpleStreamSinkSynchronousProxy

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

Formats the value using the given formatter.

impl From<Channel> for SimpleStreamSinkSynchronousProxy

Available on Fuchsia only.

fn from(value: Channel) -> Self

Converts to this type from the input type.

impl From<SimpleStreamSinkSynchronousProxy> for Handle

Available on Fuchsia only.

fn from(value: SimpleStreamSinkSynchronousProxy) -> Self

Converts to this type from the input type.

impl FromClient for SimpleStreamSinkSynchronousProxy

Available on Fuchsia only.

type Protocol = SimpleStreamSinkMarker

The protocol.

fn from_client(value: ClientEnd<SimpleStreamSinkMarker>) -> Self

Converts from a client.

impl SynchronousProxy for SimpleStreamSinkSynchronousProxy

Available on Fuchsia only.

type Proxy = SimpleStreamSinkProxy

The async proxy for the same protocol.

type Protocol = SimpleStreamSinkMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Channel

Convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the proxy has received the PEER_CLOSED signal.