kafka_protocol/messages/
describe_user_scram_credentials_request.rs

1//! DescribeUserScramCredentialsRequest
2//!
3//! See the schema for this message [here](https://github.com/apache/kafka/blob/trunk/clients/src/main/resources/common/message/DescribeUserScramCredentialsRequest.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
21#[non_exhaustive]
22#[derive(Debug, Clone, PartialEq)]
23pub struct DescribeUserScramCredentialsRequest {
24    /// The users to describe, or null/empty to describe all users.
25    ///
26    /// Supported API versions: 0
27    pub users: Option<Vec<UserName>>,
28
29    /// Other tagged fields
30    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
31}
32
33impl DescribeUserScramCredentialsRequest {
34    /// Sets `users` to the passed value.
35    ///
36    /// The users to describe, or null/empty to describe all users.
37    ///
38    /// Supported API versions: 0
39    pub fn with_users(mut self, value: Option<Vec<UserName>>) -> Self {
40        self.users = value;
41        self
42    }
43    /// Sets unknown_tagged_fields to the passed value.
44    pub fn with_unknown_tagged_fields(mut self, value: BTreeMap<i32, Bytes>) -> Self {
45        self.unknown_tagged_fields = value;
46        self
47    }
48    /// Inserts an entry into unknown_tagged_fields.
49    pub fn with_unknown_tagged_field(mut self, key: i32, value: Bytes) -> Self {
50        self.unknown_tagged_fields.insert(key, value);
51        self
52    }
53}
54
55#[cfg(feature = "client")]
56impl Encodable for DescribeUserScramCredentialsRequest {
57    fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()> {
58        if version != 0 {
59            bail!("specified version not supported by this message type");
60        }
61        types::CompactArray(types::Struct { version }).encode(buf, &self.users)?;
62        let num_tagged_fields = self.unknown_tagged_fields.len();
63        if num_tagged_fields > std::u32::MAX as usize {
64            bail!(
65                "Too many tagged fields to encode ({} fields)",
66                num_tagged_fields
67            );
68        }
69        types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
70
71        write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
72        Ok(())
73    }
74    fn compute_size(&self, version: i16) -> Result<usize> {
75        let mut total_size = 0;
76        total_size += types::CompactArray(types::Struct { version }).compute_size(&self.users)?;
77        let num_tagged_fields = self.unknown_tagged_fields.len();
78        if num_tagged_fields > std::u32::MAX as usize {
79            bail!(
80                "Too many tagged fields to encode ({} fields)",
81                num_tagged_fields
82            );
83        }
84        total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
85
86        total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
87        Ok(total_size)
88    }
89}
90
91#[cfg(feature = "broker")]
92impl Decodable for DescribeUserScramCredentialsRequest {
93    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
94        if version != 0 {
95            bail!("specified version not supported by this message type");
96        }
97        let users = types::CompactArray(types::Struct { version }).decode(buf)?;
98        let mut unknown_tagged_fields = BTreeMap::new();
99        let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
100        for _ in 0..num_tagged_fields {
101            let tag: u32 = types::UnsignedVarInt.decode(buf)?;
102            let size: u32 = types::UnsignedVarInt.decode(buf)?;
103            let unknown_value = buf.try_get_bytes(size as usize)?;
104            unknown_tagged_fields.insert(tag as i32, unknown_value);
105        }
106        Ok(Self {
107            users,
108            unknown_tagged_fields,
109        })
110    }
111}
112
113impl Default for DescribeUserScramCredentialsRequest {
114    fn default() -> Self {
115        Self {
116            users: Some(Default::default()),
117            unknown_tagged_fields: BTreeMap::new(),
118        }
119    }
120}
121
122impl Message for DescribeUserScramCredentialsRequest {
123    const VERSIONS: VersionRange = VersionRange { min: 0, max: 0 };
124    const DEPRECATED_VERSIONS: Option<VersionRange> = None;
125}
126
127/// Valid versions: 0
128#[non_exhaustive]
129#[derive(Debug, Clone, PartialEq)]
130pub struct UserName {
131    /// The user name.
132    ///
133    /// Supported API versions: 0
134    pub name: StrBytes,
135
136    /// Other tagged fields
137    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
138}
139
140impl UserName {
141    /// Sets `name` to the passed value.
142    ///
143    /// The user name.
144    ///
145    /// Supported API versions: 0
146    pub fn with_name(mut self, value: StrBytes) -> Self {
147        self.name = value;
148        self
149    }
150    /// Sets unknown_tagged_fields to the passed value.
151    pub fn with_unknown_tagged_fields(mut self, value: BTreeMap<i32, Bytes>) -> Self {
152        self.unknown_tagged_fields = value;
153        self
154    }
155    /// Inserts an entry into unknown_tagged_fields.
156    pub fn with_unknown_tagged_field(mut self, key: i32, value: Bytes) -> Self {
157        self.unknown_tagged_fields.insert(key, value);
158        self
159    }
160}
161
162#[cfg(feature = "client")]
163impl Encodable for UserName {
164    fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()> {
165        if version != 0 {
166            bail!("specified version not supported by this message type");
167        }
168        types::CompactString.encode(buf, &self.name)?;
169        let num_tagged_fields = self.unknown_tagged_fields.len();
170        if num_tagged_fields > std::u32::MAX as usize {
171            bail!(
172                "Too many tagged fields to encode ({} fields)",
173                num_tagged_fields
174            );
175        }
176        types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
177
178        write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
179        Ok(())
180    }
181    fn compute_size(&self, version: i16) -> Result<usize> {
182        let mut total_size = 0;
183        total_size += types::CompactString.compute_size(&self.name)?;
184        let num_tagged_fields = self.unknown_tagged_fields.len();
185        if num_tagged_fields > std::u32::MAX as usize {
186            bail!(
187                "Too many tagged fields to encode ({} fields)",
188                num_tagged_fields
189            );
190        }
191        total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
192
193        total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
194        Ok(total_size)
195    }
196}
197
198#[cfg(feature = "broker")]
199impl Decodable for UserName {
200    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
201        if version != 0 {
202            bail!("specified version not supported by this message type");
203        }
204        let name = types::CompactString.decode(buf)?;
205        let mut unknown_tagged_fields = BTreeMap::new();
206        let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
207        for _ in 0..num_tagged_fields {
208            let tag: u32 = types::UnsignedVarInt.decode(buf)?;
209            let size: u32 = types::UnsignedVarInt.decode(buf)?;
210            let unknown_value = buf.try_get_bytes(size as usize)?;
211            unknown_tagged_fields.insert(tag as i32, unknown_value);
212        }
213        Ok(Self {
214            name,
215            unknown_tagged_fields,
216        })
217    }
218}
219
220impl Default for UserName {
221    fn default() -> Self {
222        Self {
223            name: Default::default(),
224            unknown_tagged_fields: BTreeMap::new(),
225        }
226    }
227}
228
229impl Message for UserName {
230    const VERSIONS: VersionRange = VersionRange { min: 0, max: 0 };
231    const DEPRECATED_VERSIONS: Option<VersionRange> = None;
232}
233
234impl HeaderVersion for DescribeUserScramCredentialsRequest {
235    fn header_version(version: i16) -> i16 {
236        2
237    }
238}