Struct Client 

pub struct Client {
    pub incoming: Receiver<String>,
    pub outgoing: Sender<Command>,
    /* private fields */
}

A higher-level client wrapper that provides incoming/outgoing channels and a graceful shutdown handle for the background connection task.

Fields

incoming: Receiver<String>

Incoming lines received from the server.

outgoing: Sender<Command>

Send Command values to be written to the server.

Implementations

impl Client

pub fn start(addr: String, api_key: String) -> Self

Spawn a background task to maintain a long-lived connection to addr. Returns a Client that can send commands and receive incoming lines.

pub async fn send(&self, cmd: Command) -> Result<(), SendError<Command>>

Asynchronously send a Command to the server via the background task.

pub fn try_send(&self, cmd: Command) -> Result<(), TrySendError<Command>>

Try to synchronously send a Command without awaiting.

pub async fn shutdown(self) -> Result<(), JoinError>

Gracefully shutdown the background task and wait for it to finish.

Trait Implementations

impl Drop for Client

fn drop(&mut self)

Executes the destructor for this type.