Struct Client 

pub struct Client {
    pub stream: GenericStream,
    pub daemon_version: String,
}

This struct contains the base logic for the client. The client is responsible for connecting to the daemon, sending instructions and interpreting their responses.

use std::path::PathBuf;
use pueue_lib::{
    Client,
    Response,
    Request,
    network::socket::ConnectionSettings,
};



// Connection settings and secret to connect to the daemon.
let settings = ConnectionSettings::UnixSocket {
    path: PathBuf::from("/home/user/.local/share/pueue/pueue.socket"),
};
let secret = "My secret";

// Create a client. This already establishes a connection to the daemon.
let mut client = Client::new(settings, secret.as_bytes(), true)
    .await
    .context("Failed to initialize client.")?;

// Request the state.
client.send_request(Request::Status).await?;
let response: Response = client.receive_response().await?;

let _state = match response {
    Response::Status(state) => state,
    _ => unreachable!(),
};

Fields

stream: GenericStream

daemon_version: String

Implementations

impl Client

pub async fn new( settings: ConnectionSettings<'_>, secret: &[u8], show_version_warning: bool, ) -> Result<Self>

Initialize a new client. This includes establishing a connection to the daemon: - Connect to the daemon. - Authorize via secret. - Check versions incompatibilities.

If the show_version_warning flag is true and the daemon has a different version than the client, a warning will be logged.

pub fn stream(&mut self) -> &mut GenericStream

Convenience function to get a mutable handle on the client’s stream.

pub async fn send_request<T>(&mut self, message: T) -> Result<(), Error>

where T: Into<Request> + Serialize + Debug,

Convenience wrapper around super::send_request to directly send Requests.

pub async fn receive_response(&mut self) -> Result<Response, Error>

Convenience wrapper that wraps receive_message for Responses

pub fn daemon_version(&self) -> &String

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.