Struct Channel

pub struct Channel<T, U> { /* private fields */ }

Represents a sender of requests tied to a session, holding onto a weak reference of mailboxes to relay responses, meaning that once the Client is closed or dropped, any sent request will no longer be able to receive responses.

Implementations

impl<T, U> Channel<T, U>

where T: Send + Sync + Serialize + 'static, U: Send + Sync + DeserializeOwned + 'static,

pub fn is_closed(&self) -> bool

Returns true if no more requests can be transferred

pub fn into_untyped_channel(self) -> UntypedChannel

Consumes this channel, returning an untyped variant

pub async fn assign_default_mailbox( &self, buffer: usize, ) -> Result<Mailbox<Response<U>>>

Assigns a default mailbox for any response received that does not match another mailbox.

pub async fn remove_default_mailbox(&self) -> Result<()>

Removes the default mailbox used for unmatched responses such that any response without a matching mailbox will be dropped.

pub async fn mail( &mut self, req: impl Into<Request<T>>, ) -> Result<Mailbox<Response<U>>>

Sends a request and returns a mailbox that can receive one or more responses, failing if unable to send a request or if the session’s receiving line to the remote server has already been severed

pub async fn mail_timeout( &mut self, req: impl Into<Request<T>>, duration: impl Into<Option<Duration>>, ) -> Result<Mailbox<Response<U>>>

Sends a request and returns a mailbox, timing out after duration has passed

pub async fn send(&mut self, req: impl Into<Request<T>>) -> Result<Response<U>>

Sends a request and waits for a response, failing if unable to send a request or if the session’s receiving line to the remote server has already been severed

pub async fn send_timeout( &mut self, req: impl Into<Request<T>>, duration: impl Into<Option<Duration>>, ) -> Result<Response<U>>

Sends a request and waits for a response, timing out after duration has passed

pub async fn fire(&mut self, req: impl Into<Request<T>>) -> Result<()>

Sends a request without waiting for a response; this method is able to be used even if the session’s receiving line to the remote server has been severed

pub async fn fire_timeout( &mut self, req: impl Into<Request<T>>, duration: impl Into<Option<Duration>>, ) -> Result<()>

Sends a request without waiting for a response, timing out after duration has passed

Trait Implementations

impl<T, U> Clone for Channel<T, U>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, U> Debug for Channel<T, U>

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

Formats the value using the given formatter.

impl<T, U> From<Client<T, U>> for Channel<T, U>

fn from(client: Client<T, U>) -> Self

Converts to this type from the input type.