redfish 0.3.2

Production-grade Rust SDK for DMTF Redfish (async-first, optional blocking).
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

use std::fmt;

use serde::{Deserialize, Serialize};
use serde_json::{Map, Value};

use super::{OdataId, ResourceStatus};

/// Manager account (`ManagerAccount` resource).
///
/// Typically a member of `/redfish/v1/AccountService/Accounts`.
#[derive(Debug, Clone, Deserialize)]
pub struct Account {
    #[serde(rename = "@odata.id", default)]
    pub odata_id: Option<String>,

    #[serde(rename = "@odata.type", default)]
    pub odata_type: Option<String>,

    #[serde(rename = "Id", default)]
    pub id: Option<String>,

    #[serde(rename = "Name", default)]
    pub name: Option<String>,

    #[serde(rename = "Description", default)]
    pub description: Option<String>,

    #[serde(rename = "UserName", default)]
    pub user_name: Option<String>,

    #[serde(rename = "RoleId", default)]
    pub role_id: Option<String>,

    #[serde(rename = "Enabled", default)]
    pub enabled: Option<bool>,

    #[serde(rename = "Locked", default)]
    pub locked: Option<bool>,

    #[serde(rename = "Links", default)]
    pub links: Option<AccountLinks>,

    #[serde(rename = "Status", default)]
    pub status: Option<ResourceStatus>,

    #[serde(flatten)]
    pub extra: Map<String, Value>,
}

#[derive(Debug, Clone, Deserialize)]
pub struct AccountLinks {
    #[serde(rename = "Role", default)]
    pub role: Option<OdataId>,

    #[serde(flatten)]
    pub extra: Map<String, Value>,
}

/// Request body for `POST /AccountService/Accounts`.
#[derive(Clone, Serialize)]
pub struct AccountCreateRequest {
    #[serde(rename = "UserName")]
    user_name: String,

    #[serde(rename = "Password")]
    password: String,

    #[serde(rename = "RoleId", skip_serializing_if = "Option::is_none")]
    role_id: Option<String>,

    #[serde(rename = "Enabled", skip_serializing_if = "Option::is_none")]
    enabled: Option<bool>,
}

impl AccountCreateRequest {
    /// Create a new account creation request.
    ///
    /// The password is stored as plain text because Redfish requires it in the JSON body.
    /// The `Debug` impl redacts it.
    pub fn new(user_name: impl Into<String>, password: impl Into<String>) -> Self {
        Self {
            user_name: user_name.into(),
            password: password.into(),
            role_id: None,
            enabled: None,
        }
    }

    pub fn user_name(&self) -> &str {
        &self.user_name
    }

    pub fn role_id(mut self, role_id: impl Into<String>) -> Self {
        self.role_id = Some(role_id.into());
        self
    }

    pub fn enabled(mut self, enabled: bool) -> Self {
        self.enabled = Some(enabled);
        self
    }
}

impl fmt::Debug for AccountCreateRequest {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("AccountCreateRequest")
            .field("user_name", &self.user_name)
            .field("password", &"<redacted>")
            .field("role_id", &self.role_id)
            .field("enabled", &self.enabled)
            .finish()
    }
}

/// Request body for `PATCH /AccountService/Accounts/{id}`.
#[derive(Clone, Serialize, Default)]
pub struct AccountUpdateRequest {
    #[serde(rename = "Password", skip_serializing_if = "Option::is_none")]
    password: Option<String>,

    #[serde(rename = "RoleId", skip_serializing_if = "Option::is_none")]
    role_id: Option<String>,

    #[serde(rename = "Enabled", skip_serializing_if = "Option::is_none")]
    enabled: Option<bool>,

    #[serde(rename = "Locked", skip_serializing_if = "Option::is_none")]
    locked: Option<bool>,
}

impl AccountUpdateRequest {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn password(mut self, password: impl Into<String>) -> Self {
        self.password = Some(password.into());
        self
    }

    pub fn role_id(mut self, role_id: impl Into<String>) -> Self {
        self.role_id = Some(role_id.into());
        self
    }

    pub fn enabled(mut self, enabled: bool) -> Self {
        self.enabled = Some(enabled);
        self
    }

    pub fn locked(mut self, locked: bool) -> Self {
        self.locked = Some(locked);
        self
    }

    pub(crate) fn is_empty(&self) -> bool {
        self.password.is_none()
            && self.role_id.is_none()
            && self.enabled.is_none()
            && self.locked.is_none()
    }
}

impl fmt::Debug for AccountUpdateRequest {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("AccountUpdateRequest")
            .field("password", &self.password.as_ref().map(|_| "<redacted>"))
            .field("role_id", &self.role_id)
            .field("enabled", &self.enabled)
            .field("locked", &self.locked)
            .finish()
    }
}