kafka_protocol/messages/
consumer_group_describe_request.rs

1//! ConsumerGroupDescribeRequest
2//!
3//! See the schema for this message [here](https://github.com/apache/kafka/blob/trunk/clients/src/main/resources/common/message/ConsumerGroupDescribeRequest.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 ConsumerGroupDescribeRequest {
24    /// The ids of the groups to describe
25    ///
26    /// Supported API versions: 0
27    pub group_ids: Vec<super::GroupId>,
28
29    /// Whether to include authorized operations.
30    ///
31    /// Supported API versions: 0
32    pub include_authorized_operations: bool,
33
34    /// Other tagged fields
35    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
36}
37
38impl ConsumerGroupDescribeRequest {
39    /// Sets `group_ids` to the passed value.
40    ///
41    /// The ids of the groups to describe
42    ///
43    /// Supported API versions: 0
44    pub fn with_group_ids(mut self, value: Vec<super::GroupId>) -> Self {
45        self.group_ids = 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: 0
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 ConsumerGroupDescribeRequest {
71    fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()> {
72        types::CompactArray(types::CompactString).encode(buf, &self.group_ids)?;
73        types::Boolean.encode(buf, &self.include_authorized_operations)?;
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        types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
82
83        write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
84        Ok(())
85    }
86    fn compute_size(&self, version: i16) -> Result<usize> {
87        let mut total_size = 0;
88        total_size += types::CompactArray(types::CompactString).compute_size(&self.group_ids)?;
89        total_size += types::Boolean.compute_size(&self.include_authorized_operations)?;
90        let num_tagged_fields = self.unknown_tagged_fields.len();
91        if num_tagged_fields > std::u32::MAX as usize {
92            bail!(
93                "Too many tagged fields to encode ({} fields)",
94                num_tagged_fields
95            );
96        }
97        total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
98
99        total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
100        Ok(total_size)
101    }
102}
103
104#[cfg(feature = "broker")]
105impl Decodable for ConsumerGroupDescribeRequest {
106    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
107        let group_ids = types::CompactArray(types::CompactString).decode(buf)?;
108        let include_authorized_operations = types::Boolean.decode(buf)?;
109        let mut unknown_tagged_fields = BTreeMap::new();
110        let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
111        for _ in 0..num_tagged_fields {
112            let tag: u32 = types::UnsignedVarInt.decode(buf)?;
113            let size: u32 = types::UnsignedVarInt.decode(buf)?;
114            let unknown_value = buf.try_get_bytes(size as usize)?;
115            unknown_tagged_fields.insert(tag as i32, unknown_value);
116        }
117        Ok(Self {
118            group_ids,
119            include_authorized_operations,
120            unknown_tagged_fields,
121        })
122    }
123}
124
125impl Default for ConsumerGroupDescribeRequest {
126    fn default() -> Self {
127        Self {
128            group_ids: Default::default(),
129            include_authorized_operations: false,
130            unknown_tagged_fields: BTreeMap::new(),
131        }
132    }
133}
134
135impl Message for ConsumerGroupDescribeRequest {
136    const VERSIONS: VersionRange = VersionRange { min: 0, max: 0 };
137    const DEPRECATED_VERSIONS: Option<VersionRange> = None;
138}
139
140impl HeaderVersion for ConsumerGroupDescribeRequest {
141    fn header_version(version: i16) -> i16 {
142        2
143    }
144}
kafka_protocol/messages/consumer_group_describe_request.rs

kafka_protocol/messages/
consumer_group_describe_request.rs
