leeca_proxmox 0.2.0

A modern, safe, and async-first SDK for interacting with Proxmox Virtual Environment servers
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

use crate::core::domain::value_object::{
    ProxmoxHost, ProxmoxPassword, ProxmoxPort, ProxmoxRealm, ProxmoxUrl, ProxmoxUsername,
};

/// Connection details for a Proxmox server.
///
/// This struct holds all validated configuration needed to connect.
/// Fields are private; access is via getters.
#[derive(Debug, Clone)]
pub struct ProxmoxConnection {
    host: ProxmoxHost,
    port: ProxmoxPort,
    username: ProxmoxUsername,
    password: ProxmoxPassword,
    realm: ProxmoxRealm,
    secure: bool,
    accept_invalid_certs: bool,
    url: ProxmoxUrl,
}

#[allow(clippy::too_many_arguments)]
impl ProxmoxConnection {
    /// Creates a new connection instance (internal use only, values are already validated).
    pub(crate) fn new(
        host: ProxmoxHost,
        port: ProxmoxPort,
        username: ProxmoxUsername,
        password: ProxmoxPassword,
        realm: ProxmoxRealm,
        secure: bool,
        accept_invalid_certs: bool,
        url: ProxmoxUrl,
    ) -> Self {
        Self {
            host,
            port,
            username,
            password,
            realm,
            secure,
            accept_invalid_certs,
            url,
        }
    }

    /// Returns the host.
    #[allow(dead_code)] // Part of public API, not yet used internally.
    pub fn host(&self) -> &ProxmoxHost {
        &self.host
    }

    /// Returns the port.
    #[allow(dead_code)] // Part of public API, not yet used internally.
    pub fn port(&self) -> &ProxmoxPort {
        &self.port
    }

    /// Returns the username.
    pub fn username(&self) -> &ProxmoxUsername {
        &self.username
    }

    /// Returns the password.
    pub fn password(&self) -> &ProxmoxPassword {
        &self.password
    }

    /// Returns the realm.
    pub fn realm(&self) -> &ProxmoxRealm {
        &self.realm
    }

    /// Returns whether HTTPS is used.
    #[allow(dead_code)] // Part of public API, not yet used internally.
    pub fn is_secure(&self) -> bool {
        self.secure
    }

    /// Returns whether invalid certificates are accepted.
    pub fn accept_invalid_certs(&self) -> bool {
        self.accept_invalid_certs
    }

    /// Returns the base URL.
    pub fn url(&self) -> &ProxmoxUrl {
        &self.url
    }
}