walrus-client 0.0.1

Client library for the Walrus daemon
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

//! Walrus client library — Unix domain socket client for connecting to a
//! walrus-gateway. Used by walrus-cli and other platform clients.

pub use connection::Connection;
use std::path::PathBuf;

pub mod connection;

/// Client configuration for connecting to a walrus-gateway.
#[derive(Debug, Clone)]
pub struct ClientConfig {
    /// Gateway Unix domain socket path.
    pub socket_path: PathBuf,
}

impl Default for ClientConfig {
    fn default() -> Self {
        Self {
            socket_path: default_socket_path(),
        }
    }
}

/// Default socket path: `~/.walrus/walrus.sock`.
fn default_socket_path() -> PathBuf {
    dirs::home_dir()
        .expect("no home directory")
        .join(".walrus")
        .join("walrus.sock")
}

/// Unix domain socket client for the walrus-gateway.
///
/// Holds configuration. Call [`WalrusClient::connect`] to establish a
/// connection.
pub struct WalrusClient {
    config: ClientConfig,
}

impl WalrusClient {
    /// Create a new client with the given configuration.
    pub fn new(config: ClientConfig) -> Self {
        Self { config }
    }

    /// Access the client configuration.
    pub fn config(&self) -> &ClientConfig {
        &self.config
    }

    /// Set the gateway socket path.
    pub fn socket_path(mut self, path: impl Into<PathBuf>) -> Self {
        self.config.socket_path = path.into();
        self
    }

    /// Connect to the gateway and return a [`Connection`].
    pub async fn connect(&self) -> anyhow::Result<Connection> {
        Connection::connect(&self.config.socket_path).await
    }
}