kafka_protocol/messages/
describe_groups_request.rs

1//! DescribeGroupsRequest
2//!
3//! See the schema for this message [here](https://github.com/apache/kafka/blob/trunk/clients/src/main/resources/common/message/DescribeGroupsRequest.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-5
21#[non_exhaustive]
22#[derive(Debug, Clone, PartialEq)]
23pub struct DescribeGroupsRequest {
24    /// The names of the groups to describe
25    ///
26    /// Supported API versions: 0-5
27    pub groups: Vec<super::GroupId>,
28
29    /// Whether to include authorized operations.
30    ///
31    /// Supported API versions: 3-5
32    pub include_authorized_operations: bool,
33
34    /// Other tagged fields
35    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
36}
37
38impl DescribeGroupsRequest {
39    /// Sets `groups` to the passed value.
40    ///
41    /// The names of the groups to describe
42    ///
43    /// Supported API versions: 0-5
44    pub fn with_groups(mut self, value: Vec<super::GroupId>) -> Self {
45        self.groups = value;
46        self
47    }
48    /// Sets `include_authorized_operations` to the passed value.
49    ///
50    /// Whether to include authorized operations.
51    ///
52    /// Supported API versions: 3-5
53    pub fn with_include_authorized_operations(mut self, value: bool) -> Self {
54        self.include_authorized_operations = 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 DescribeGroupsRequest {
71    fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()> {
72        if version >= 5 {
73            types::CompactArray(types::CompactString).encode(buf, &self.groups)?;
74        } else {
75            types::Array(types::String).encode(buf, &self.groups)?;
76        }
77        if version >= 3 {
78            types::Boolean.encode(buf, &self.include_authorized_operations)?;
79        } else {
80            if self.include_authorized_operations {
81                bail!("A field is set that is not available on the selected protocol version");
82            }
83        }
84        if version >= 5 {
85            let num_tagged_fields = self.unknown_tagged_fields.len();
86            if num_tagged_fields > std::u32::MAX as usize {
87                bail!(
88                    "Too many tagged fields to encode ({} fields)",
89                    num_tagged_fields
90                );
91            }
92            types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
93
94            write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
95        }
96        Ok(())
97    }
98    fn compute_size(&self, version: i16) -> Result<usize> {
99        let mut total_size = 0;
100        if version >= 5 {
101            total_size += types::CompactArray(types::CompactString).compute_size(&self.groups)?;
102        } else {
103            total_size += types::Array(types::String).compute_size(&self.groups)?;
104        }
105        if version >= 3 {
106            total_size += types::Boolean.compute_size(&self.include_authorized_operations)?;
107        } else {
108            if self.include_authorized_operations {
109                bail!("A field is set that is not available on the selected protocol version");
110            }
111        }
112        if version >= 5 {
113            let num_tagged_fields = self.unknown_tagged_fields.len();
114            if num_tagged_fields > std::u32::MAX as usize {
115                bail!(
116                    "Too many tagged fields to encode ({} fields)",
117                    num_tagged_fields
118                );
119            }
120            total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
121
122            total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
123        }
124        Ok(total_size)
125    }
126}
127
128#[cfg(feature = "broker")]
129impl Decodable for DescribeGroupsRequest {
130    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
131        let groups = if version >= 5 {
132            types::CompactArray(types::CompactString).decode(buf)?
133        } else {
134            types::Array(types::String).decode(buf)?
135        };
136        let include_authorized_operations = if version >= 3 {
137            types::Boolean.decode(buf)?
138        } else {
139            false
140        };
141        let mut unknown_tagged_fields = BTreeMap::new();
142        if version >= 5 {
143            let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
144            for _ in 0..num_tagged_fields {
145                let tag: u32 = types::UnsignedVarInt.decode(buf)?;
146                let size: u32 = types::UnsignedVarInt.decode(buf)?;
147                let unknown_value = buf.try_get_bytes(size as usize)?;
148                unknown_tagged_fields.insert(tag as i32, unknown_value);
149            }
150        }
151        Ok(Self {
152            groups,
153            include_authorized_operations,
154            unknown_tagged_fields,
155        })
156    }
157}
158
159impl Default for DescribeGroupsRequest {
160    fn default() -> Self {
161        Self {
162            groups: Default::default(),
163            include_authorized_operations: false,
164            unknown_tagged_fields: BTreeMap::new(),
165        }
166    }
167}
168
169impl Message for DescribeGroupsRequest {
170    const VERSIONS: VersionRange = VersionRange { min: 0, max: 5 };
171    const DEPRECATED_VERSIONS: Option<VersionRange> = None;
172}
173
174impl HeaderVersion for DescribeGroupsRequest {
175    fn header_version(version: i16) -> i16 {
176        if version >= 5 {
177            2
178        } else {
179            1
180        }
181    }
182}
kafka_protocol/messages/describe_groups_request.rs

kafka_protocol/messages/
describe_groups_request.rs
