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        types::CompactArray(types::Struct { version }).encode(buf, &self.users)?;
59        let num_tagged_fields = self.unknown_tagged_fields.len();
60        if num_tagged_fields > std::u32::MAX as usize {
61            bail!(
62                "Too many tagged fields to encode ({} fields)",
63                num_tagged_fields
64            );
65        }
66        types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
67
68        write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
69        Ok(())
70    }
71    fn compute_size(&self, version: i16) -> Result<usize> {
72        let mut total_size = 0;
73        total_size += types::CompactArray(types::Struct { version }).compute_size(&self.users)?;
74        let num_tagged_fields = self.unknown_tagged_fields.len();
75        if num_tagged_fields > std::u32::MAX as usize {
76            bail!(
77                "Too many tagged fields to encode ({} fields)",
78                num_tagged_fields
79            );
80        }
81        total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
82
83        total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
84        Ok(total_size)
85    }
86}
87
88#[cfg(feature = "broker")]
89impl Decodable for DescribeUserScramCredentialsRequest {
90    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
91        let users = types::CompactArray(types::Struct { version }).decode(buf)?;
92        let mut unknown_tagged_fields = BTreeMap::new();
93        let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
94        for _ in 0..num_tagged_fields {
95            let tag: u32 = types::UnsignedVarInt.decode(buf)?;
96            let size: u32 = types::UnsignedVarInt.decode(buf)?;
97            let unknown_value = buf.try_get_bytes(size as usize)?;
98            unknown_tagged_fields.insert(tag as i32, unknown_value);
99        }
100        Ok(Self {
101            users,
102            unknown_tagged_fields,
103        })
104    }
105}
106
107impl Default for DescribeUserScramCredentialsRequest {
108    fn default() -> Self {
109        Self {
110            users: Some(Default::default()),
111            unknown_tagged_fields: BTreeMap::new(),
112        }
113    }
114}
115
116impl Message for DescribeUserScramCredentialsRequest {
117    const VERSIONS: VersionRange = VersionRange { min: 0, max: 0 };
118    const DEPRECATED_VERSIONS: Option<VersionRange> = None;
119}
120
121/// Valid versions: 0
122#[non_exhaustive]
123#[derive(Debug, Clone, PartialEq)]
124pub struct UserName {
125    /// The user name.
126    ///
127    /// Supported API versions: 0
128    pub name: StrBytes,
129
130    /// Other tagged fields
131    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
132}
133
134impl UserName {
135    /// Sets `name` to the passed value.
136    ///
137    /// The user name.
138    ///
139    /// Supported API versions: 0
140    pub fn with_name(mut self, value: StrBytes) -> Self {
141        self.name = value;
142        self
143    }
144    /// Sets unknown_tagged_fields to the passed value.
145    pub fn with_unknown_tagged_fields(mut self, value: BTreeMap<i32, Bytes>) -> Self {
146        self.unknown_tagged_fields = value;
147        self
148    }
149    /// Inserts an entry into unknown_tagged_fields.
150    pub fn with_unknown_tagged_field(mut self, key: i32, value: Bytes) -> Self {
151        self.unknown_tagged_fields.insert(key, value);
152        self
153    }
154}
155
156#[cfg(feature = "client")]
157impl Encodable for UserName {
158    fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()> {
159        types::CompactString.encode(buf, &self.name)?;
160        let num_tagged_fields = self.unknown_tagged_fields.len();
161        if num_tagged_fields > std::u32::MAX as usize {
162            bail!(
163                "Too many tagged fields to encode ({} fields)",
164                num_tagged_fields
165            );
166        }
167        types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
168
169        write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
170        Ok(())
171    }
172    fn compute_size(&self, version: i16) -> Result<usize> {
173        let mut total_size = 0;
174        total_size += types::CompactString.compute_size(&self.name)?;
175        let num_tagged_fields = self.unknown_tagged_fields.len();
176        if num_tagged_fields > std::u32::MAX as usize {
177            bail!(
178                "Too many tagged fields to encode ({} fields)",
179                num_tagged_fields
180            );
181        }
182        total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
183
184        total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
185        Ok(total_size)
186    }
187}
188
189#[cfg(feature = "broker")]
190impl Decodable for UserName {
191    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
192        let name = types::CompactString.decode(buf)?;
193        let mut unknown_tagged_fields = BTreeMap::new();
194        let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
195        for _ in 0..num_tagged_fields {
196            let tag: u32 = types::UnsignedVarInt.decode(buf)?;
197            let size: u32 = types::UnsignedVarInt.decode(buf)?;
198            let unknown_value = buf.try_get_bytes(size as usize)?;
199            unknown_tagged_fields.insert(tag as i32, unknown_value);
200        }
201        Ok(Self {
202            name,
203            unknown_tagged_fields,
204        })
205    }
206}
207
208impl Default for UserName {
209    fn default() -> Self {
210        Self {
211            name: Default::default(),
212            unknown_tagged_fields: BTreeMap::new(),
213        }
214    }
215}
216
217impl Message for UserName {
218    const VERSIONS: VersionRange = VersionRange { min: 0, max: 0 };
219    const DEPRECATED_VERSIONS: Option<VersionRange> = None;
220}
221
222impl HeaderVersion for DescribeUserScramCredentialsRequest {
223    fn header_version(version: i16) -> i16 {
224        2
225    }
226}
kafka_protocol/messages/describe_user_scram_credentials_request.rs

kafka_protocol/messages/
describe_user_scram_credentials_request.rs
