confluent_kafka/admin/
log_dir_description.rs1use crate::common::requests::DescribeLogDirsResponse;
18use std::collections::HashMap;
19
20use crate::common::Error;
21use crate::common::TopicPartition;
22
23use super::ReplicaInfo;
24
25#[derive(Clone, Debug)]
27#[doc(alias = "org.apache.kafka.clients.admin.LogDirDescription")]
28pub struct LogDirDescription {
29 error: Option<Error>,
30 replica_infos: HashMap<TopicPartition, ReplicaInfo>,
31 total_bytes: Option<i64>,
32 usable_bytes: Option<i64>,
33 is_cordoned: bool,
34}
35
36impl LogDirDescription {
37 #[doc(alias = "org.apache.kafka.clients.admin.LogDirDescription#LogDirDescription")]
45 pub fn new(error: Option<Error>, replica_infos: HashMap<TopicPartition, ReplicaInfo>) -> Self {
46 Self::with_total_bytes_usable_bytes_is_cordoned(
47 error,
48 replica_infos,
49 DescribeLogDirsResponse::UNKNOWN_VOLUME_BYTES,
50 DescribeLogDirsResponse::UNKNOWN_VOLUME_BYTES,
51 false,
52 )
53 }
54
55 #[doc(alias = "org.apache.kafka.clients.admin.LogDirDescription#LogDirDescription")]
66 pub fn with_total_bytes_usable_bytes(
67 error: Option<Error>,
68 replica_infos: HashMap<TopicPartition, ReplicaInfo>,
69 total_bytes: i64,
70 usable_bytes: i64,
71 ) -> Self {
72 Self::with_total_bytes_usable_bytes_is_cordoned(error, replica_infos, total_bytes, usable_bytes, false)
73 }
74
75 #[doc(alias = "org.apache.kafka.clients.admin.LogDirDescription#LogDirDescription")]
88 pub fn with_total_bytes_usable_bytes_is_cordoned(
89 error: Option<Error>,
90 replica_infos: HashMap<TopicPartition, ReplicaInfo>,
91 total_bytes: i64,
92 usable_bytes: i64,
93 is_cordoned: bool,
94 ) -> Self {
95 Self {
96 error,
97 replica_infos,
98 total_bytes: (total_bytes != DescribeLogDirsResponse::UNKNOWN_VOLUME_BYTES).then_some(total_bytes),
99 usable_bytes: (usable_bytes != DescribeLogDirsResponse::UNKNOWN_VOLUME_BYTES).then_some(usable_bytes),
100 is_cordoned,
101 }
102 }
103
104 #[doc(alias = "org.apache.kafka.clients.admin.LogDirDescription#error")]
110 pub fn error(&self) -> Option<&Error> {
111 self.error.as_ref()
112 }
113
114 #[doc(alias = "org.apache.kafka.clients.admin.LogDirDescription#replicaInfos")]
117 pub fn replica_infos(&self) -> &HashMap<TopicPartition, ReplicaInfo> {
118 &self.replica_infos
119 }
120
121 #[doc(alias = "org.apache.kafka.clients.admin.LogDirDescription#totalBytes")]
125 pub fn total_bytes(&self) -> Option<i64> {
126 self.total_bytes
127 }
128
129 #[doc(alias = "org.apache.kafka.clients.admin.LogDirDescription#usableBytes")]
133 pub fn usable_bytes(&self) -> Option<i64> {
134 self.usable_bytes
135 }
136
137 #[doc(alias = "org.apache.kafka.clients.admin.LogDirDescription#isCordoned")]
139 pub fn is_cordoned(&self) -> bool {
140 self.is_cordoned
141 }
142}
143
144impl std::fmt::Display for LogDirDescription {
145 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
146 write!(
147 f,
148 "LogDirDescription(replicaInfos={:?}, error={:?}, totalBytes={:?}, usableBytes={:?}, isCordoned={})",
149 self.replica_infos, self.error, self.total_bytes, self.usable_bytes, self.is_cordoned
150 )
151 }
152}
153
154#[cfg(test)]
155mod tests {
156 use super::*;
157 use crate::common::protocol::Errors;
158
159 #[test]
160 fn unknown_volume_bytes_maps_to_none() {
161 let d = LogDirDescription::new(None, HashMap::new());
162 assert!(d.error().is_none());
163 assert_eq!(d.total_bytes(), None);
164 assert_eq!(d.usable_bytes(), None);
165 assert!(!d.is_cordoned());
166 }
167
168 #[test]
169 fn cordoned_flag_is_carried() {
170 let d = LogDirDescription::with_total_bytes_usable_bytes_is_cordoned(None, HashMap::new(), -1, -1, true);
171 assert!(d.is_cordoned());
172 assert_eq!(d.total_bytes(), None);
173 let d2 = LogDirDescription::with_total_bytes_usable_bytes(None, HashMap::new(), 1, 2);
175 assert!(!d2.is_cordoned());
176 }
177
178 #[test]
179 fn known_volume_bytes_are_present() {
180 let d = LogDirDescription::with_total_bytes_usable_bytes(
181 Some(Error::new(Errors::KafkaStorageError)),
182 HashMap::new(),
183 123,
184 456,
185 );
186 assert_eq!(d.error().unwrap().error(), Errors::KafkaStorageError);
187 assert_eq!(d.total_bytes(), Some(123));
188 assert_eq!(d.usable_bytes(), Some(456));
189 }
190}