Struct SimpleStreamSinkProxy

pub struct SimpleStreamSinkProxy { /* private fields */ }

Implementations

impl SimpleStreamSinkProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.media/SimpleStreamSink.

pub fn take_event_stream(&self) -> SimpleStreamSinkEventStream

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

Panics

Panics if the event stream was already taken.

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, ) -> QueryResponseFut<(), DefaultFuchsiaResourceDialect>

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, ) -> QueryResponseFut<(), DefaultFuchsiaResourceDialect>

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 Clone for SimpleStreamSinkProxy

fn clone(&self) -> SimpleStreamSinkProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SimpleStreamSinkProxy

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

Formats the value using the given formatter.

impl Proxy for SimpleStreamSinkProxy

type Protocol = SimpleStreamSinkMarker

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.

impl SimpleStreamSinkProxyInterface for SimpleStreamSinkProxy

type SendPacketResponseFut = QueryResponseFut<()>

type DiscardAllPacketsResponseFut = QueryResponseFut<()>

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

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

fn send_packet(&self, packet: &StreamPacket) -> Self::SendPacketResponseFut

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

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

fn discard_all_packets(&self) -> Self::DiscardAllPacketsResponseFut

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