Struct Handle 

pub struct Handle { /* private fields */ }

Sends commands to a running Stream; cheap to clone.

Implementations

impl Handle

pub fn new(cmd_tx: Sender<Command>) -> Self

Wrap the command sender of a driver; normally obtained from Stream::new.

pub async fn connect(&self) -> Result<(), Error>

Open the connection (no-op if already connected).

pub fn try_connect(&self) -> Result<(), Error>

Like Handle::connect, but fails with Error::QueueFull instead of waiting.

pub async fn disconnect(&self) -> Result<(), Error>

Close the connection; the driver stays alive and can connect again.

pub fn try_disconnect(&self) -> Result<(), Error>

Like Handle::disconnect, but fails with Error::QueueFull instead of waiting.

pub async fn send_command(&self, msg: OutgoingMessage) -> Result<(), Error>

Send a raw message on the current connection (not restored after a reconnect).

pub fn try_send_command(&self, msg: OutgoingMessage) -> Result<(), Error>

Like Handle::send_command, but fails with Error::QueueFull instead of waiting.

pub async fn subscribe(&self, topics: Vec<Topic>) -> Result<(), Error>

Subscribe to topics now and again after every reconnect.

pub fn try_subscribe(&self, topics: Vec<Topic>) -> Result<(), Error>

Like Handle::subscribe, but fails with Error::QueueFull instead of waiting.

pub async fn unsubscribe(&self, topics: Vec<Topic>) -> Result<(), Error>

Unsubscribe from topics and stop restoring them.

pub fn try_unsubscribe(&self, topics: Vec<Topic>) -> Result<(), Error>

Like Handle::unsubscribe, but fails with Error::QueueFull instead of waiting.

Trait Implementations

impl Clone for Handle

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Handle

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

Formats the value using the given formatter.