Struct fidl::client::Client

source ·
pub struct Client { /* private fields */ }
Expand description

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

Implementations§

source§

impl Client

source

pub fn new(channel: AsyncChannel, protocol_name: &'static str) -> Client

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.

source

pub fn as_channel(&self) -> &AsyncChannel

Get a reference to the client’s underlying channel.

source

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

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.

source

pub fn take_event_receiver(&self) -> EventReceiver

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

source

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

Encodes and sends a request without expecting a response.

source

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

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

source

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

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

source

pub fn send_raw( &self, bytes: &[u8], handles: &mut [HandleDisposition<'_>] ) -> Result<(), Error>

Sends a raw message without expecting a response.

source

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

Sends a raw query and receives a response future.

Trait Implementations§

source§

impl Clone for Client

source§

fn clone(&self) -> Client

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
source§

impl Debug for Client

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

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> Encode<Ambiguous1> for T

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _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> Encode<Ambiguous2> for T

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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,

§

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>,

§

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>,

§

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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more