kafka_protocol/messages/
describe_delegation_token_request.rs

1//! DescribeDelegationTokenRequest
2//!
3//! See the schema for this message [here](https://github.com/apache/kafka/blob/trunk/clients/src/main/resources/common/message/DescribeDelegationTokenRequest.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 DescribeDelegationTokenOwner {
24    /// The owner principal type.
25    ///
26    /// Supported API versions: 0-3
27    pub principal_type: StrBytes,
28
29    /// The owner principal name.
30    ///
31    /// Supported API versions: 0-3
32    pub principal_name: StrBytes,
33
34    /// Other tagged fields
35    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
36}
37
38impl DescribeDelegationTokenOwner {
39    /// Sets `principal_type` to the passed value.
40    ///
41    /// The owner principal type.
42    ///
43    /// Supported API versions: 0-3
44    pub fn with_principal_type(mut self, value: StrBytes) -> Self {
45        self.principal_type = value;
46        self
47    }
48    /// Sets `principal_name` to the passed value.
49    ///
50    /// The owner principal name.
51    ///
52    /// Supported API versions: 0-3
53    pub fn with_principal_name(mut self, value: StrBytes) -> Self {
54        self.principal_name = value;
55        self
56    }
57    /// Sets unknown_tagged_fields to the passed value.
58    pub fn with_unknown_tagged_fields(mut self, value: BTreeMap<i32, Bytes>) -> Self {
59        self.unknown_tagged_fields = value;
60        self
61    }
62    /// Inserts an entry into unknown_tagged_fields.
63    pub fn with_unknown_tagged_field(mut self, key: i32, value: Bytes) -> Self {
64        self.unknown_tagged_fields.insert(key, value);
65        self
66    }
67}
68
69#[cfg(feature = "client")]
70impl Encodable for DescribeDelegationTokenOwner {
71    fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()> {
72        if version >= 2 {
73            types::CompactString.encode(buf, &self.principal_type)?;
74        } else {
75            types::String.encode(buf, &self.principal_type)?;
76        }
77        if version >= 2 {
78            types::CompactString.encode(buf, &self.principal_name)?;
79        } else {
80            types::String.encode(buf, &self.principal_name)?;
81        }
82        if version >= 2 {
83            let num_tagged_fields = self.unknown_tagged_fields.len();
84            if num_tagged_fields > std::u32::MAX as usize {
85                bail!(
86                    "Too many tagged fields to encode ({} fields)",
87                    num_tagged_fields
88                );
89            }
90            types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
91
92            write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
93        }
94        Ok(())
95    }
96    fn compute_size(&self, version: i16) -> Result<usize> {
97        let mut total_size = 0;
98        if version >= 2 {
99            total_size += types::CompactString.compute_size(&self.principal_type)?;
100        } else {
101            total_size += types::String.compute_size(&self.principal_type)?;
102        }
103        if version >= 2 {
104            total_size += types::CompactString.compute_size(&self.principal_name)?;
105        } else {
106            total_size += types::String.compute_size(&self.principal_name)?;
107        }
108        if version >= 2 {
109            let num_tagged_fields = self.unknown_tagged_fields.len();
110            if num_tagged_fields > std::u32::MAX as usize {
111                bail!(
112                    "Too many tagged fields to encode ({} fields)",
113                    num_tagged_fields
114                );
115            }
116            total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
117
118            total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
119        }
120        Ok(total_size)
121    }
122}
123
124#[cfg(feature = "broker")]
125impl Decodable for DescribeDelegationTokenOwner {
126    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
127        let principal_type = if version >= 2 {
128            types::CompactString.decode(buf)?
129        } else {
130            types::String.decode(buf)?
131        };
132        let principal_name = if version >= 2 {
133            types::CompactString.decode(buf)?
134        } else {
135            types::String.decode(buf)?
136        };
137        let mut unknown_tagged_fields = BTreeMap::new();
138        if version >= 2 {
139            let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
140            for _ in 0..num_tagged_fields {
141                let tag: u32 = types::UnsignedVarInt.decode(buf)?;
142                let size: u32 = types::UnsignedVarInt.decode(buf)?;
143                let unknown_value = buf.try_get_bytes(size as usize)?;
144                unknown_tagged_fields.insert(tag as i32, unknown_value);
145            }
146        }
147        Ok(Self {
148            principal_type,
149            principal_name,
150            unknown_tagged_fields,
151        })
152    }
153}
154
155impl Default for DescribeDelegationTokenOwner {
156    fn default() -> Self {
157        Self {
158            principal_type: Default::default(),
159            principal_name: Default::default(),
160            unknown_tagged_fields: BTreeMap::new(),
161        }
162    }
163}
164
165impl Message for DescribeDelegationTokenOwner {
166    const VERSIONS: VersionRange = VersionRange { min: 0, max: 3 };
167    const DEPRECATED_VERSIONS: Option<VersionRange> = Some(VersionRange { min: 0, max: 0 });
168}
169
170/// Valid versions: 0-3
171#[non_exhaustive]
172#[derive(Debug, Clone, PartialEq)]
173pub struct DescribeDelegationTokenRequest {
174    /// Each owner that we want to describe delegation tokens for, or null to describe all tokens.
175    ///
176    /// Supported API versions: 0-3
177    pub owners: Option<Vec<DescribeDelegationTokenOwner>>,
178
179    /// Other tagged fields
180    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
181}
182
183impl DescribeDelegationTokenRequest {
184    /// Sets `owners` to the passed value.
185    ///
186    /// Each owner that we want to describe delegation tokens for, or null to describe all tokens.
187    ///
188    /// Supported API versions: 0-3
189    pub fn with_owners(mut self, value: Option<Vec<DescribeDelegationTokenOwner>>) -> Self {
190        self.owners = value;
191        self
192    }
193    /// Sets unknown_tagged_fields to the passed value.
194    pub fn with_unknown_tagged_fields(mut self, value: BTreeMap<i32, Bytes>) -> Self {
195        self.unknown_tagged_fields = value;
196        self
197    }
198    /// Inserts an entry into unknown_tagged_fields.
199    pub fn with_unknown_tagged_field(mut self, key: i32, value: Bytes) -> Self {
200        self.unknown_tagged_fields.insert(key, value);
201        self
202    }
203}
204
205#[cfg(feature = "client")]
206impl Encodable for DescribeDelegationTokenRequest {
207    fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()> {
208        if version >= 2 {
209            types::CompactArray(types::Struct { version }).encode(buf, &self.owners)?;
210        } else {
211            types::Array(types::Struct { version }).encode(buf, &self.owners)?;
212        }
213        if version >= 2 {
214            let num_tagged_fields = self.unknown_tagged_fields.len();
215            if num_tagged_fields > std::u32::MAX as usize {
216                bail!(
217                    "Too many tagged fields to encode ({} fields)",
218                    num_tagged_fields
219                );
220            }
221            types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
222
223            write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
224        }
225        Ok(())
226    }
227    fn compute_size(&self, version: i16) -> Result<usize> {
228        let mut total_size = 0;
229        if version >= 2 {
230            total_size +=
231                types::CompactArray(types::Struct { version }).compute_size(&self.owners)?;
232        } else {
233            total_size += types::Array(types::Struct { version }).compute_size(&self.owners)?;
234        }
235        if version >= 2 {
236            let num_tagged_fields = self.unknown_tagged_fields.len();
237            if num_tagged_fields > std::u32::MAX as usize {
238                bail!(
239                    "Too many tagged fields to encode ({} fields)",
240                    num_tagged_fields
241                );
242            }
243            total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
244
245            total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
246        }
247        Ok(total_size)
248    }
249}
250
251#[cfg(feature = "broker")]
252impl Decodable for DescribeDelegationTokenRequest {
253    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
254        let owners = if version >= 2 {
255            types::CompactArray(types::Struct { version }).decode(buf)?
256        } else {
257            types::Array(types::Struct { version }).decode(buf)?
258        };
259        let mut unknown_tagged_fields = BTreeMap::new();
260        if version >= 2 {
261            let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
262            for _ in 0..num_tagged_fields {
263                let tag: u32 = types::UnsignedVarInt.decode(buf)?;
264                let size: u32 = types::UnsignedVarInt.decode(buf)?;
265                let unknown_value = buf.try_get_bytes(size as usize)?;
266                unknown_tagged_fields.insert(tag as i32, unknown_value);
267            }
268        }
269        Ok(Self {
270            owners,
271            unknown_tagged_fields,
272        })
273    }
274}
275
276impl Default for DescribeDelegationTokenRequest {
277    fn default() -> Self {
278        Self {
279            owners: Some(Default::default()),
280            unknown_tagged_fields: BTreeMap::new(),
281        }
282    }
283}
284
285impl Message for DescribeDelegationTokenRequest {
286    const VERSIONS: VersionRange = VersionRange { min: 0, max: 3 };
287    const DEPRECATED_VERSIONS: Option<VersionRange> = Some(VersionRange { min: 0, max: 0 });
288}
289
290impl HeaderVersion for DescribeDelegationTokenRequest {
291    fn header_version(version: i16) -> i16 {
292        if version >= 2 {
293            2
294        } else {
295            1
296        }
297    }
298}