kafka_protocol/messages/
describe_acls_request.rs

1//! DescribeAclsRequest
2//!
3//! See the schema for this message [here](https://github.com/apache/kafka/blob/trunk/clients/src/main/resources/common/message/DescribeAclsRequest.json).
4// WARNING: the items of this module are generated and should not be edited directly
5#![allow(unused)]
6
7use std::borrow::Borrow;
8use std::collections::BTreeMap;
9
10use anyhow::{bail, Result};
11use bytes::Bytes;
12use uuid::Uuid;
13
14use crate::protocol::{
15    buf::{ByteBuf, ByteBufMut},
16    compute_unknown_tagged_fields_size, types, write_unknown_tagged_fields, Decodable, Decoder,
17    Encodable, Encoder, HeaderVersion, Message, StrBytes, VersionRange,
18};
19
20/// Valid versions: 0-3
21#[non_exhaustive]
22#[derive(Debug, Clone, PartialEq)]
23pub struct DescribeAclsRequest {
24    /// The resource type.
25    ///
26    /// Supported API versions: 0-3
27    pub resource_type_filter: i8,
28
29    /// The resource name, or null to match any resource name.
30    ///
31    /// Supported API versions: 0-3
32    pub resource_name_filter: Option<StrBytes>,
33
34    /// The resource pattern to match.
35    ///
36    /// Supported API versions: 1-3
37    pub pattern_type_filter: i8,
38
39    /// The principal to match, or null to match any principal.
40    ///
41    /// Supported API versions: 0-3
42    pub principal_filter: Option<StrBytes>,
43
44    /// The host to match, or null to match any host.
45    ///
46    /// Supported API versions: 0-3
47    pub host_filter: Option<StrBytes>,
48
49    /// The operation to match.
50    ///
51    /// Supported API versions: 0-3
52    pub operation: i8,
53
54    /// The permission type to match.
55    ///
56    /// Supported API versions: 0-3
57    pub permission_type: i8,
58
59    /// Other tagged fields
60    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
61}
62
63impl DescribeAclsRequest {
64    /// Sets `resource_type_filter` to the passed value.
65    ///
66    /// The resource type.
67    ///
68    /// Supported API versions: 0-3
69    pub fn with_resource_type_filter(mut self, value: i8) -> Self {
70        self.resource_type_filter = value;
71        self
72    }
73    /// Sets `resource_name_filter` to the passed value.
74    ///
75    /// The resource name, or null to match any resource name.
76    ///
77    /// Supported API versions: 0-3
78    pub fn with_resource_name_filter(mut self, value: Option<StrBytes>) -> Self {
79        self.resource_name_filter = value;
80        self
81    }
82    /// Sets `pattern_type_filter` to the passed value.
83    ///
84    /// The resource pattern to match.
85    ///
86    /// Supported API versions: 1-3
87    pub fn with_pattern_type_filter(mut self, value: i8) -> Self {
88        self.pattern_type_filter = value;
89        self
90    }
91    /// Sets `principal_filter` to the passed value.
92    ///
93    /// The principal to match, or null to match any principal.
94    ///
95    /// Supported API versions: 0-3
96    pub fn with_principal_filter(mut self, value: Option<StrBytes>) -> Self {
97        self.principal_filter = value;
98        self
99    }
100    /// Sets `host_filter` to the passed value.
101    ///
102    /// The host to match, or null to match any host.
103    ///
104    /// Supported API versions: 0-3
105    pub fn with_host_filter(mut self, value: Option<StrBytes>) -> Self {
106        self.host_filter = value;
107        self
108    }
109    /// Sets `operation` to the passed value.
110    ///
111    /// The operation to match.
112    ///
113    /// Supported API versions: 0-3
114    pub fn with_operation(mut self, value: i8) -> Self {
115        self.operation = value;
116        self
117    }
118    /// Sets `permission_type` to the passed value.
119    ///
120    /// The permission type to match.
121    ///
122    /// Supported API versions: 0-3
123    pub fn with_permission_type(mut self, value: i8) -> Self {
124        self.permission_type = value;
125        self
126    }
127    /// Sets unknown_tagged_fields to the passed value.
128    pub fn with_unknown_tagged_fields(mut self, value: BTreeMap<i32, Bytes>) -> Self {
129        self.unknown_tagged_fields = value;
130        self
131    }
132    /// Inserts an entry into unknown_tagged_fields.
133    pub fn with_unknown_tagged_field(mut self, key: i32, value: Bytes) -> Self {
134        self.unknown_tagged_fields.insert(key, value);
135        self
136    }
137}
138
139#[cfg(feature = "client")]
140impl Encodable for DescribeAclsRequest {
141    fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()> {
142        types::Int8.encode(buf, &self.resource_type_filter)?;
143        if version >= 2 {
144            types::CompactString.encode(buf, &self.resource_name_filter)?;
145        } else {
146            types::String.encode(buf, &self.resource_name_filter)?;
147        }
148        if version >= 1 {
149            types::Int8.encode(buf, &self.pattern_type_filter)?;
150        } else {
151            if self.pattern_type_filter != 3 {
152                bail!("A field is set that is not available on the selected protocol version");
153            }
154        }
155        if version >= 2 {
156            types::CompactString.encode(buf, &self.principal_filter)?;
157        } else {
158            types::String.encode(buf, &self.principal_filter)?;
159        }
160        if version >= 2 {
161            types::CompactString.encode(buf, &self.host_filter)?;
162        } else {
163            types::String.encode(buf, &self.host_filter)?;
164        }
165        types::Int8.encode(buf, &self.operation)?;
166        types::Int8.encode(buf, &self.permission_type)?;
167        if version >= 2 {
168            let num_tagged_fields = self.unknown_tagged_fields.len();
169            if num_tagged_fields > std::u32::MAX as usize {
170                bail!(
171                    "Too many tagged fields to encode ({} fields)",
172                    num_tagged_fields
173                );
174            }
175            types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
176
177            write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
178        }
179        Ok(())
180    }
181    fn compute_size(&self, version: i16) -> Result<usize> {
182        let mut total_size = 0;
183        total_size += types::Int8.compute_size(&self.resource_type_filter)?;
184        if version >= 2 {
185            total_size += types::CompactString.compute_size(&self.resource_name_filter)?;
186        } else {
187            total_size += types::String.compute_size(&self.resource_name_filter)?;
188        }
189        if version >= 1 {
190            total_size += types::Int8.compute_size(&self.pattern_type_filter)?;
191        } else {
192            if self.pattern_type_filter != 3 {
193                bail!("A field is set that is not available on the selected protocol version");
194            }
195        }
196        if version >= 2 {
197            total_size += types::CompactString.compute_size(&self.principal_filter)?;
198        } else {
199            total_size += types::String.compute_size(&self.principal_filter)?;
200        }
201        if version >= 2 {
202            total_size += types::CompactString.compute_size(&self.host_filter)?;
203        } else {
204            total_size += types::String.compute_size(&self.host_filter)?;
205        }
206        total_size += types::Int8.compute_size(&self.operation)?;
207        total_size += types::Int8.compute_size(&self.permission_type)?;
208        if version >= 2 {
209            let num_tagged_fields = self.unknown_tagged_fields.len();
210            if num_tagged_fields > std::u32::MAX as usize {
211                bail!(
212                    "Too many tagged fields to encode ({} fields)",
213                    num_tagged_fields
214                );
215            }
216            total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
217
218            total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
219        }
220        Ok(total_size)
221    }
222}
223
224#[cfg(feature = "broker")]
225impl Decodable for DescribeAclsRequest {
226    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
227        let resource_type_filter = types::Int8.decode(buf)?;
228        let resource_name_filter = if version >= 2 {
229            types::CompactString.decode(buf)?
230        } else {
231            types::String.decode(buf)?
232        };
233        let pattern_type_filter = if version >= 1 {
234            types::Int8.decode(buf)?
235        } else {
236            3
237        };
238        let principal_filter = if version >= 2 {
239            types::CompactString.decode(buf)?
240        } else {
241            types::String.decode(buf)?
242        };
243        let host_filter = if version >= 2 {
244            types::CompactString.decode(buf)?
245        } else {
246            types::String.decode(buf)?
247        };
248        let operation = types::Int8.decode(buf)?;
249        let permission_type = types::Int8.decode(buf)?;
250        let mut unknown_tagged_fields = BTreeMap::new();
251        if version >= 2 {
252            let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
253            for _ in 0..num_tagged_fields {
254                let tag: u32 = types::UnsignedVarInt.decode(buf)?;
255                let size: u32 = types::UnsignedVarInt.decode(buf)?;
256                let unknown_value = buf.try_get_bytes(size as usize)?;
257                unknown_tagged_fields.insert(tag as i32, unknown_value);
258            }
259        }
260        Ok(Self {
261            resource_type_filter,
262            resource_name_filter,
263            pattern_type_filter,
264            principal_filter,
265            host_filter,
266            operation,
267            permission_type,
268            unknown_tagged_fields,
269        })
270    }
271}
272
273impl Default for DescribeAclsRequest {
274    fn default() -> Self {
275        Self {
276            resource_type_filter: 0,
277            resource_name_filter: Some(Default::default()),
278            pattern_type_filter: 3,
279            principal_filter: Some(Default::default()),
280            host_filter: Some(Default::default()),
281            operation: 0,
282            permission_type: 0,
283            unknown_tagged_fields: BTreeMap::new(),
284        }
285    }
286}
287
288impl Message for DescribeAclsRequest {
289    const VERSIONS: VersionRange = VersionRange { min: 0, max: 3 };
290    const DEPRECATED_VERSIONS: Option<VersionRange> = Some(VersionRange { min: 0, max: 0 });
291}
292
293impl HeaderVersion for DescribeAclsRequest {
294    fn header_version(version: i16) -> i16 {
295        if version >= 2 {
296            2
297        } else {
298            1
299        }
300    }
301}
kafka_protocol/messages/describe_acls_request.rs

kafka_protocol/messages/
describe_acls_request.rs
