Struct FDomainProxy 

pub struct FDomainProxy { /* private fields */ }

Implementations

impl FDomainProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.fdomain/FDomain.

pub fn take_event_stream(&self) -> FDomainEventStream

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

Panics

Panics if the event stream was already taken.

pub fn create_channel( &self, handles: &[NewHandleId; 2], ) -> QueryResponseFut<ChannelCreateChannelResult, DefaultFuchsiaResourceDialect>

Create a new channel in this FDomain and return both its ends.

pub fn read_channel( &self, handle: &HandleId, ) -> QueryResponseFut<ChannelReadChannelResult, DefaultFuchsiaResourceDialect>

Read a message from a channel. This method will fail if the channel is currently being read using the streaming read functions.

Note that this method is not like zx_channel_read in that it will not return SHOULD_WAIT but will instead delay returning until there is data to return.

pub fn write_channel( &self, handle: &HandleId, data: &[u8], handles: &Handles, ) -> QueryResponseFut<ChannelWriteChannelResult, DefaultFuchsiaResourceDialect>

Write to a channel. Handles are always consumed.

pub fn read_channel_streaming_start( &self, handle: &HandleId, ) -> QueryResponseFut<ChannelReadChannelStreamingStartResult, DefaultFuchsiaResourceDialect>

Starts reading from the given channel. Data is returned via the ChannelStreamingData event. That event will occur repeatedly until ReadChannelStreamingStop is called for the same handle or the event indicates the handle is closed.

pub fn read_channel_streaming_stop( &self, handle: &HandleId, ) -> QueryResponseFut<ChannelReadChannelStreamingStopResult, DefaultFuchsiaResourceDialect>

Stop asynchronous reading from the given channel.

pub fn create_event( &self, handle: &NewHandleId, ) -> QueryResponseFut<EventCreateEventResult, DefaultFuchsiaResourceDialect>

Create a new event in this FDomain and return it.

pub fn create_event_pair( &self, handles: &[NewHandleId; 2], ) -> QueryResponseFut<EventPairCreateEventPairResult, DefaultFuchsiaResourceDialect>

Create a new event pair in this FDomain and return both its ends.

pub fn create_socket( &self, options: SocketType, handles: &[NewHandleId; 2], ) -> QueryResponseFut<SocketCreateSocketResult, DefaultFuchsiaResourceDialect>

Create a new socket in this FDomain and return both its ends.

pub fn set_socket_disposition( &self, handle: &HandleId, disposition: SocketDisposition, disposition_peer: SocketDisposition, ) -> QueryResponseFut<SocketSetSocketDispositionResult, DefaultFuchsiaResourceDialect>

Set the disposition of a given socket.

pub fn read_socket( &self, handle: &HandleId, max_bytes: u64, ) -> QueryResponseFut<SocketReadSocketResult, DefaultFuchsiaResourceDialect>

Read data from a socket. This method will fail if the socket is currently being read asynchronously.

pub fn write_socket( &self, handle: &HandleId, data: &[u8], ) -> QueryResponseFut<SocketWriteSocketResult, DefaultFuchsiaResourceDialect>

Write to a socket. This will attempt to write all the data passed, and will block and retry whenever it is safe (e.g. it should never return SHOULD_WAIT). The WriteSocketError contains a wrote parameter to indicate if some bytes were written successfully before the failure occurred.

pub fn read_socket_streaming_start( &self, handle: &HandleId, ) -> QueryResponseFut<SocketReadSocketStreamingStartResult, DefaultFuchsiaResourceDialect>

Starts reading from the given socket. Data is returned via the SocketStreamingData event. That event will occur repeatedly until ReadSocketStreamingStop is called for the same handle or the event indicates the handle is closed.

pub fn read_socket_streaming_stop( &self, handle: &HandleId, ) -> QueryResponseFut<SocketReadSocketStreamingStopResult, DefaultFuchsiaResourceDialect>

Stop asynchronous reading from the given socket.

pub fn get_namespace( &self, new_handle: &NewHandleId, ) -> QueryResponseFut<FDomainGetNamespaceResult, DefaultFuchsiaResourceDialect>

Adds a new channel handle to this namespace which points to a fuchsia.io.Directory. Can be used to “bootstrap” the FDomain.

pub fn close( &self, handles: &[HandleId], ) -> QueryResponseFut<FDomainCloseResult, DefaultFuchsiaResourceDialect>

Close one or more handles.

pub fn duplicate( &self, handle: &HandleId, new_handle: &NewHandleId, rights: Rights, ) -> QueryResponseFut<FDomainDuplicateResult, DefaultFuchsiaResourceDialect>

Duplicate a handle.

pub fn replace( &self, handle: &HandleId, new_handle: &NewHandleId, rights: Rights, ) -> QueryResponseFut<FDomainReplaceResult, DefaultFuchsiaResourceDialect>

Close a handle and replace it with a new one with possibly different rights.

pub fn signal( &self, handle: &HandleId, set: u32, clear: u32, ) -> QueryResponseFut<FDomainSignalResult, DefaultFuchsiaResourceDialect>

Set or clear signals on a handle.

pub fn signal_peer( &self, handle: &HandleId, set: u32, clear: u32, ) -> QueryResponseFut<FDomainSignalPeerResult, DefaultFuchsiaResourceDialect>

Set or clear signals on a handle’s peer.

pub fn wait_for_signals( &self, handle: &HandleId, signals: u32, ) -> QueryResponseFut<FDomainWaitForSignalsResult, DefaultFuchsiaResourceDialect>

Wait for signals from the given handle. Reply will be returned when one of the given signals is asserted.

pub fn get_koid( &self, handle: &HandleId, ) -> QueryResponseFut<FDomainGetKoidResult, DefaultFuchsiaResourceDialect>

Return the kernel object ID (koid) of the handle.

Trait Implementations

impl Clone for FDomainProxy

fn clone(&self) -> FDomainProxy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FDomainProxy

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

Formats the value using the given formatter.

impl FDomainProxyInterface for FDomainProxy

type CreateChannelResponseFut = QueryResponseFut<Result<(), Error>>

type ReadChannelResponseFut = QueryResponseFut<Result<(Vec<u8>, Vec<HandleInfo>), Error>>

type WriteChannelResponseFut = QueryResponseFut<Result<(), WriteChannelError>>

type ReadChannelStreamingStartResponseFut = QueryResponseFut<Result<(), Error>>

type ReadChannelStreamingStopResponseFut = QueryResponseFut<Result<(), Error>>

type CreateEventResponseFut = QueryResponseFut<Result<(), Error>>

type CreateEventPairResponseFut = QueryResponseFut<Result<(), Error>>

type CreateSocketResponseFut = QueryResponseFut<Result<(), Error>>

type SetSocketDispositionResponseFut = QueryResponseFut<Result<(), Error>>

type ReadSocketResponseFut = QueryResponseFut<Result<(Vec<u8>, bool), Error>>

type WriteSocketResponseFut = QueryResponseFut<Result<u64, WriteSocketError>>

type ReadSocketStreamingStartResponseFut = QueryResponseFut<Result<(), Error>>

type ReadSocketStreamingStopResponseFut = QueryResponseFut<Result<(), Error>>

type GetNamespaceResponseFut = QueryResponseFut<Result<(), Error>>

type CloseResponseFut = QueryResponseFut<Result<(), Error>>

type DuplicateResponseFut = QueryResponseFut<Result<(), Error>>

type ReplaceResponseFut = QueryResponseFut<Result<(), Error>>

type SignalResponseFut = QueryResponseFut<Result<(), Error>>

type SignalPeerResponseFut = QueryResponseFut<Result<(), Error>>

type WaitForSignalsResponseFut = QueryResponseFut<Result<u32, Error>>

type GetKoidResponseFut = QueryResponseFut<Result<u64, Error>>

fn create_channel( &self, handles: &[NewHandleId; 2], ) -> Self::CreateChannelResponseFut

fn read_channel(&self, handle: &HandleId) -> Self::ReadChannelResponseFut

fn write_channel( &self, handle: &HandleId, data: &[u8], handles: &Handles, ) -> Self::WriteChannelResponseFut

fn read_channel_streaming_start( &self, handle: &HandleId, ) -> Self::ReadChannelStreamingStartResponseFut

fn read_channel_streaming_stop( &self, handle: &HandleId, ) -> Self::ReadChannelStreamingStopResponseFut

fn create_event(&self, handle: &NewHandleId) -> Self::CreateEventResponseFut

fn create_event_pair( &self, handles: &[NewHandleId; 2], ) -> Self::CreateEventPairResponseFut

fn create_socket( &self, options: SocketType, handles: &[NewHandleId; 2], ) -> Self::CreateSocketResponseFut

fn set_socket_disposition( &self, handle: &HandleId, disposition: SocketDisposition, disposition_peer: SocketDisposition, ) -> Self::SetSocketDispositionResponseFut

fn read_socket( &self, handle: &HandleId, max_bytes: u64, ) -> Self::ReadSocketResponseFut

fn write_socket( &self, handle: &HandleId, data: &[u8], ) -> Self::WriteSocketResponseFut

fn read_socket_streaming_start( &self, handle: &HandleId, ) -> Self::ReadSocketStreamingStartResponseFut

fn read_socket_streaming_stop( &self, handle: &HandleId, ) -> Self::ReadSocketStreamingStopResponseFut

fn get_namespace( &self, new_handle: &NewHandleId, ) -> Self::GetNamespaceResponseFut

fn close(&self, handles: &[HandleId]) -> Self::CloseResponseFut

fn duplicate( &self, handle: &HandleId, new_handle: &NewHandleId, rights: Rights, ) -> Self::DuplicateResponseFut

fn replace( &self, handle: &HandleId, new_handle: &NewHandleId, rights: Rights, ) -> Self::ReplaceResponseFut

fn signal( &self, handle: &HandleId, set: u32, clear: u32, ) -> Self::SignalResponseFut

fn signal_peer( &self, handle: &HandleId, set: u32, clear: u32, ) -> Self::SignalPeerResponseFut

fn wait_for_signals( &self, handle: &HandleId, signals: u32, ) -> Self::WaitForSignalsResponseFut

fn get_koid(&self, handle: &HandleId) -> Self::GetKoidResponseFut

impl Proxy for FDomainProxy

type Protocol = FDomainMarker

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<'_, NullableHandle>>

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