Struct carrier_pigeon::OptionPendingClient

pub struct OptionPendingClient { /* private fields */ }

An optional version of the PendingClient.

Get a OptionPendingClient with the option() method of the PendingClient, or with the Into/From traits.

Represents a pending client that could have been received already. This type is useful when you can only get a mutable reference to this (not own it).

The most notable difference is the take method only takes &mut self, instead of self, and the returns from most methods are wrapped in an option.

Implementations

impl OptionPendingClient

pub fn done(&self) -> Option<bool>

Returns whether the client is finished connecting.

pub fn take<R: Any + Send + Sync>(&mut self) -> Option<Result<(Client, R)>>

Takes the io::Result<Client> from the PendingClient. This will yield a value if done() returned true.

Panics

Panics if R is not the response message type.

pub fn block<R: Any + Send + Sync>(self) -> Option<Result<(Client, R)>>

Blocks until the client is ready.

Panics

Panics if the generic parameter R isn’t the response message type (the same R that you passed into MsgTable::build).

Trait Implementations

impl Debug for OptionPendingClient

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

Formats the value using the given formatter.

impl Display for OptionPendingClient

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

Formats the value using the given formatter.

impl Into<OptionPendingClient> for PendingClient

fn into(self) -> OptionPendingClient

Converts this type into the (usually inferred) input type.