Struct Client

pub struct Client<D = DefaultFuchsiaResourceDialect>
where D: ResourceDialect,
{ /* private fields */ }
Expand description

A FIDL client which can be used to send buffers and receive responses via a channel.

Implementations§

§

impl<D> Client<D>
where D: ResourceDialect,

pub fn new( channel: <D as ResourceDialect>::ProxyChannel, protocol_name: &'static str, ) -> Client<D>

Create a new client.

channel is the asynchronous channel over which data is sent and received. event_ordinals are the ordinals on which events will be received.

pub fn as_channel(&self) -> &<D as ResourceDialect>::ProxyChannel

Get a reference to the client’s underlying channel.

pub fn into_channel( self, ) -> Result<<D as ResourceDialect>::ProxyChannel, Client<D>>

Attempt to convert the Client back into a channel.

This will only succeed if there are no active clones of this Client, no currently-alive EventReceiver or MessageResponses that came from this Client, and no outstanding messages awaiting a response, even if that response will be discarded.

pub fn take_event_receiver(&self) -> EventReceiver<D>

Retrieve the stream of event messages for the Client. Panics if the stream was already taken.

pub fn send<T>( &self, body: impl Encode<T, D>, ordinal: u64, dynamic_flags: DynamicFlags, ) -> Result<(), Error>
where T: TypeMarker,

Encodes and sends a request without expecting a response.

pub fn send_query<Request, Response, const ORDINAL: u64>( &self, body: impl Encode<Request, D>, dynamic_flags: DynamicFlags, ) -> QueryResponseFut<<Response as TypeMarker>::Owned, D>
where Request: TypeMarker, Response: TypeMarker, <Response as TypeMarker>::Owned: Decode<Response, D>,

Encodes and sends a request. Returns a future that decodes the response.

pub fn send_query_and_decode<Request, Output>( &self, body: impl Encode<Request, D>, ordinal: u64, dynamic_flags: DynamicFlags, decode: fn(_: Result<<D as ResourceDialect>::MessageBufEtc, Error>) -> Result<Output, Error>, ) -> QueryResponseFut<Output, D>
where Request: TypeMarker,

Encodes and sends a request. Returns a future that decodes the response using the given decode function.

pub fn send_raw( &self, bytes: &[u8], handles: &mut [<<D as ResourceDialect>::ProxyChannel as ProxyChannelFor<D>>::HandleDisposition], ) -> Result<(), Error>

Sends a raw message without expecting a response.

pub fn send_raw_query<F>( &self, encode_msg: F, ) -> Result<MessageResponse<D>, Error>
where F: for<'a, 'b> FnOnce(Txid, &'a mut Vec<u8>, &'b mut Vec<<<D as ResourceDialect>::ProxyChannel as ProxyChannelFor<D>>::HandleDisposition>) -> Result<(), Error>,

Sends a raw query and receives a response future.

Trait Implementations§

§

impl<D> Clone for Client<D>

§

fn clone(&self) -> Client<D>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl<D> Debug for Client<D>

§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<D> Freeze for Client<D>

§

impl<D = DefaultFuchsiaResourceDialect> !RefUnwindSafe for Client<D>

§

impl<D> Send for Client<D>

§

impl<D> Sync for Client<D>

§

impl<D> Unpin for Client<D>

§

impl<D = DefaultFuchsiaResourceDialect> !UnwindSafe for Client<D>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
§

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.