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: 1-3
21#[non_exhaustive]
22#[derive(Debug, Clone, PartialEq)]
23pub struct DescribeAclsRequest {
24    /// The resource type.
25    ///
26    /// Supported API versions: 1-3
27    pub resource_type_filter: i8,
28
29    /// The resource name, or null to match any resource name.
30    ///
31    /// Supported API versions: 1-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: 1-3
42    pub principal_filter: Option<StrBytes>,
43
44    /// The host to match, or null to match any host.
45    ///
46    /// Supported API versions: 1-3
47    pub host_filter: Option<StrBytes>,
48
49    /// The operation to match.
50    ///
51    /// Supported API versions: 1-3
52    pub operation: i8,
53
54    /// The permission type to match.
55    ///
56    /// Supported API versions: 1-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: 1-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: 1-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: 1-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: 1-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: 1-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: 1-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        if version < 1 || version > 3 {
143            bail!("specified version not supported by this message type");
144        }
145        types::Int8.encode(buf, &self.resource_type_filter)?;
146        if version >= 2 {
147            types::CompactString.encode(buf, &self.resource_name_filter)?;
148        } else {
149            types::String.encode(buf, &self.resource_name_filter)?;
150        }
151        types::Int8.encode(buf, &self.pattern_type_filter)?;
152        if version >= 2 {
153            types::CompactString.encode(buf, &self.principal_filter)?;
154        } else {
155            types::String.encode(buf, &self.principal_filter)?;
156        }
157        if version >= 2 {
158            types::CompactString.encode(buf, &self.host_filter)?;
159        } else {
160            types::String.encode(buf, &self.host_filter)?;
161        }
162        types::Int8.encode(buf, &self.operation)?;
163        types::Int8.encode(buf, &self.permission_type)?;
164        if version >= 2 {
165            let num_tagged_fields = self.unknown_tagged_fields.len();
166            if num_tagged_fields > std::u32::MAX as usize {
167                bail!(
168                    "Too many tagged fields to encode ({} fields)",
169                    num_tagged_fields
170                );
171            }
172            types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
173
174            write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
175        }
176        Ok(())
177    }
178    fn compute_size(&self, version: i16) -> Result<usize> {
179        let mut total_size = 0;
180        total_size += types::Int8.compute_size(&self.resource_type_filter)?;
181        if version >= 2 {
182            total_size += types::CompactString.compute_size(&self.resource_name_filter)?;
183        } else {
184            total_size += types::String.compute_size(&self.resource_name_filter)?;
185        }
186        total_size += types::Int8.compute_size(&self.pattern_type_filter)?;
187        if version >= 2 {
188            total_size += types::CompactString.compute_size(&self.principal_filter)?;
189        } else {
190            total_size += types::String.compute_size(&self.principal_filter)?;
191        }
192        if version >= 2 {
193            total_size += types::CompactString.compute_size(&self.host_filter)?;
194        } else {
195            total_size += types::String.compute_size(&self.host_filter)?;
196        }
197        total_size += types::Int8.compute_size(&self.operation)?;
198        total_size += types::Int8.compute_size(&self.permission_type)?;
199        if version >= 2 {
200            let num_tagged_fields = self.unknown_tagged_fields.len();
201            if num_tagged_fields > std::u32::MAX as usize {
202                bail!(
203                    "Too many tagged fields to encode ({} fields)",
204                    num_tagged_fields
205                );
206            }
207            total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
208
209            total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
210        }
211        Ok(total_size)
212    }
213}
214
215#[cfg(feature = "broker")]
216impl Decodable for DescribeAclsRequest {
217    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
218        if version < 1 || version > 3 {
219            bail!("specified version not supported by this message type");
220        }
221        let resource_type_filter = types::Int8.decode(buf)?;
222        let resource_name_filter = if version >= 2 {
223            types::CompactString.decode(buf)?
224        } else {
225            types::String.decode(buf)?
226        };
227        let pattern_type_filter = types::Int8.decode(buf)?;
228        let principal_filter = if version >= 2 {
229            types::CompactString.decode(buf)?
230        } else {
231            types::String.decode(buf)?
232        };
233        let host_filter = if version >= 2 {
234            types::CompactString.decode(buf)?
235        } else {
236            types::String.decode(buf)?
237        };
238        let operation = types::Int8.decode(buf)?;
239        let permission_type = types::Int8.decode(buf)?;
240        let mut unknown_tagged_fields = BTreeMap::new();
241        if version >= 2 {
242            let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
243            for _ in 0..num_tagged_fields {
244                let tag: u32 = types::UnsignedVarInt.decode(buf)?;
245                let size: u32 = types::UnsignedVarInt.decode(buf)?;
246                let unknown_value = buf.try_get_bytes(size as usize)?;
247                unknown_tagged_fields.insert(tag as i32, unknown_value);
248            }
249        }
250        Ok(Self {
251            resource_type_filter,
252            resource_name_filter,
253            pattern_type_filter,
254            principal_filter,
255            host_filter,
256            operation,
257            permission_type,
258            unknown_tagged_fields,
259        })
260    }
261}
262
263impl Default for DescribeAclsRequest {
264    fn default() -> Self {
265        Self {
266            resource_type_filter: 0,
267            resource_name_filter: Some(Default::default()),
268            pattern_type_filter: 3,
269            principal_filter: Some(Default::default()),
270            host_filter: Some(Default::default()),
271            operation: 0,
272            permission_type: 0,
273            unknown_tagged_fields: BTreeMap::new(),
274        }
275    }
276}
277
278impl Message for DescribeAclsRequest {
279    const VERSIONS: VersionRange = VersionRange { min: 1, max: 3 };
280    const DEPRECATED_VERSIONS: Option<VersionRange> = None;
281}
282
283impl HeaderVersion for DescribeAclsRequest {
284    fn header_version(version: i16) -> i16 {
285        if version >= 2 {
286            2
287        } else {
288            1
289        }
290    }
291}
kafka_protocol/messages/describe_acls_request.rs

kafka_protocol/messages/
describe_acls_request.rs
