proxmox-api 0.2.0

Rust bindings for the Proxmox VE HTTP API
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

#[derive(Debug, Clone)]
pub struct AclClient<T> {
    client: T,
    path: String,
}
impl<T> AclClient<T>
where
    T: crate::client::Client,
{
    pub fn new(client: T, parent_path: &str) -> Self {
        Self {
            client,
            path: format!("{}{}", parent_path, "/acl"),
        }
    }
}
impl<T> AclClient<T>
where
    T: crate::client::Client,
{
    #[doc = "Get Access Control List (ACLs)."]
    #[doc = ""]
    #[doc = "The returned list is restricted to objects where you have rights to modify permissions."]
    pub async fn get(&self) -> Result<Vec<GetOutputItems>, T::Error> {
        let path = self.path.to_string();
        let optional_vec: Option<Vec<GetOutputItems>> = self.client.get(&path, &()).await?;
        Ok(optional_vec.unwrap_or_default())
    }
}
impl<T> AclClient<T>
where
    T: crate::client::Client,
{
    #[doc = "Update Access Control List (add or remove permissions)."]
    #[doc = ""]
    #[doc = "Permission check: perm-modify(\"{path}\")"]
    pub async fn put(&self, params: PutParams) -> Result<(), T::Error> {
        let path = self.path.to_string();
        self.client.put(&path, &params).await
    }
}
impl GetOutputItems {
    pub fn new(path: String, roleid: String, ty: Type, ugid: String) -> Self {
        Self {
            path,
            roleid,
            ty,
            ugid,
            propagate: ::std::default::Default::default(),
        }
    }
}
#[derive(Clone, Debug, :: serde :: Serialize, :: serde :: Deserialize)]
pub struct GetOutputItems {
    #[doc = "Access control path"]
    #[doc = ""]
    pub path: String,
    #[serde(
        serialize_with = "crate::types::serialize_bool_optional",
        deserialize_with = "crate::types::deserialize_bool_optional"
    )]
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "Allow to propagate (inherit) permissions."]
    #[doc = ""]
    pub propagate: Option<bool>,
    pub roleid: String,
    #[serde(rename = "type")]
    pub ty: Type,
    pub ugid: String,
}
impl PutParams {
    pub fn new(path: String, roles: String) -> Self {
        Self {
            path,
            roles,
            delete: ::std::default::Default::default(),
            groups: ::std::default::Default::default(),
            propagate: ::std::default::Default::default(),
            tokens: ::std::default::Default::default(),
            users: ::std::default::Default::default(),
            additional_properties: ::std::default::Default::default(),
        }
    }
}
#[derive(Clone, Debug, :: serde :: Serialize, :: serde :: Deserialize)]
pub struct PutParams {
    #[serde(
        serialize_with = "crate::types::serialize_bool_optional",
        deserialize_with = "crate::types::deserialize_bool_optional"
    )]
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "Remove permissions (instead of adding it)."]
    #[doc = ""]
    pub delete: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "List of groups."]
    #[doc = ""]
    pub groups: Option<String>,
    #[doc = "Access control path"]
    #[doc = ""]
    pub path: String,
    #[serde(
        serialize_with = "crate::types::serialize_bool_optional",
        deserialize_with = "crate::types::deserialize_bool_optional"
    )]
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "Allow to propagate (inherit) permissions."]
    #[doc = ""]
    pub propagate: Option<bool>,
    #[doc = "List of roles."]
    #[doc = ""]
    pub roles: String,
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "List of API tokens."]
    #[doc = ""]
    pub tokens: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "List of users."]
    #[doc = ""]
    pub users: Option<String>,
    #[serde(
        flatten,
        default,
        skip_serializing_if = "::std::collections::HashMap::is_empty"
    )]
    pub additional_properties: ::std::collections::HashMap<String, ::serde_json::Value>,
}
#[derive(Clone, Debug, :: serde :: Serialize, :: serde :: Deserialize, PartialEq)]
pub enum Type {
    #[serde(rename = "group")]
    Group,
    #[serde(rename = "token")]
    Token,
    #[serde(rename = "user")]
    User,
}
impl TryFrom<&str> for Type {
    type Error = String;
    fn try_from(value: &str) -> Result<Self, <Self as TryFrom<&str>>::Error> {
        match value {
            "group" => Ok(Self::Group),
            "token" => Ok(Self::Token),
            "user" => Ok(Self::User),
            v => Err(format!("Unknown variant {v}")),
        }
    }
}