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 < 0 || version > 5 {
73            bail!("specified version not supported by this message type");
74        }
75        if version >= 5 {
76            types::CompactArray(types::CompactString).encode(buf, &self.groups)?;
77        } else {
78            types::Array(types::String).encode(buf, &self.groups)?;
79        }
80        if version >= 3 {
81            types::Boolean.encode(buf, &self.include_authorized_operations)?;
82        } else {
83            if self.include_authorized_operations {
84                bail!("A field is set that is not available on the selected protocol version");
85            }
86        }
87        if version >= 5 {
88            let num_tagged_fields = self.unknown_tagged_fields.len();
89            if num_tagged_fields > std::u32::MAX as usize {
90                bail!(
91                    "Too many tagged fields to encode ({} fields)",
92                    num_tagged_fields
93                );
94            }
95            types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
96
97            write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
98        }
99        Ok(())
100    }
101    fn compute_size(&self, version: i16) -> Result<usize> {
102        let mut total_size = 0;
103        if version >= 5 {
104            total_size += types::CompactArray(types::CompactString).compute_size(&self.groups)?;
105        } else {
106            total_size += types::Array(types::String).compute_size(&self.groups)?;
107        }
108        if version >= 3 {
109            total_size += types::Boolean.compute_size(&self.include_authorized_operations)?;
110        } else {
111            if self.include_authorized_operations {
112                bail!("A field is set that is not available on the selected protocol version");
113            }
114        }
115        if version >= 5 {
116            let num_tagged_fields = self.unknown_tagged_fields.len();
117            if num_tagged_fields > std::u32::MAX as usize {
118                bail!(
119                    "Too many tagged fields to encode ({} fields)",
120                    num_tagged_fields
121                );
122            }
123            total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
124
125            total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
126        }
127        Ok(total_size)
128    }
129}
130
131#[cfg(feature = "broker")]
132impl Decodable for DescribeGroupsRequest {
133    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
134        if version < 0 || version > 5 {
135            bail!("specified version not supported by this message type");
136        }
137        let groups = if version >= 5 {
138            types::CompactArray(types::CompactString).decode(buf)?
139        } else {
140            types::Array(types::String).decode(buf)?
141        };
142        let include_authorized_operations = if version >= 3 {
143            types::Boolean.decode(buf)?
144        } else {
145            false
146        };
147        let mut unknown_tagged_fields = BTreeMap::new();
148        if version >= 5 {
149            let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
150            for _ in 0..num_tagged_fields {
151                let tag: u32 = types::UnsignedVarInt.decode(buf)?;
152                let size: u32 = types::UnsignedVarInt.decode(buf)?;
153                let unknown_value = buf.try_get_bytes(size as usize)?;
154                unknown_tagged_fields.insert(tag as i32, unknown_value);
155            }
156        }
157        Ok(Self {
158            groups,
159            include_authorized_operations,
160            unknown_tagged_fields,
161        })
162    }
163}
164
165impl Default for DescribeGroupsRequest {
166    fn default() -> Self {
167        Self {
168            groups: Default::default(),
169            include_authorized_operations: false,
170            unknown_tagged_fields: BTreeMap::new(),
171        }
172    }
173}
174
175impl Message for DescribeGroupsRequest {
176    const VERSIONS: VersionRange = VersionRange { min: 0, max: 5 };
177    const DEPRECATED_VERSIONS: Option<VersionRange> = None;
178}
179
180impl HeaderVersion for DescribeGroupsRequest {
181    fn header_version(version: i16) -> i16 {
182        if version >= 5 {
183            2
184        } else {
185            1
186        }
187    }
188}
kafka_protocol/messages/describe_groups_request.rs

kafka_protocol/messages/
describe_groups_request.rs
