kafka_protocol/messages/
api_versions_request.rs

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

kafka_protocol/messages/
api_versions_request.rs
