kafka_protocol/messages/
envelope_request.rs

1//! EnvelopeRequest
2//!
3//! See the schema for this message [here](https://github.com/apache/kafka/blob/trunk/clients/src/main/resources/common/message/EnvelopeRequest.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 EnvelopeRequest {
24    /// The embedded request header and data.
25    ///
26    /// Supported API versions: 0
27    pub request_data: Bytes,
28
29    /// Value of the initial client principal when the request is redirected by a broker.
30    ///
31    /// Supported API versions: 0
32    pub request_principal: Option<Bytes>,
33
34    /// The original client's address in bytes.
35    ///
36    /// Supported API versions: 0
37    pub client_host_address: Bytes,
38
39    /// Other tagged fields
40    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
41}
42
43impl EnvelopeRequest {
44    /// Sets `request_data` to the passed value.
45    ///
46    /// The embedded request header and data.
47    ///
48    /// Supported API versions: 0
49    pub fn with_request_data(mut self, value: Bytes) -> Self {
50        self.request_data = value;
51        self
52    }
53    /// Sets `request_principal` to the passed value.
54    ///
55    /// Value of the initial client principal when the request is redirected by a broker.
56    ///
57    /// Supported API versions: 0
58    pub fn with_request_principal(mut self, value: Option<Bytes>) -> Self {
59        self.request_principal = value;
60        self
61    }
62    /// Sets `client_host_address` to the passed value.
63    ///
64    /// The original client's address in bytes.
65    ///
66    /// Supported API versions: 0
67    pub fn with_client_host_address(mut self, value: Bytes) -> Self {
68        self.client_host_address = value;
69        self
70    }
71    /// Sets unknown_tagged_fields to the passed value.
72    pub fn with_unknown_tagged_fields(mut self, value: BTreeMap<i32, Bytes>) -> Self {
73        self.unknown_tagged_fields = value;
74        self
75    }
76    /// Inserts an entry into unknown_tagged_fields.
77    pub fn with_unknown_tagged_field(mut self, key: i32, value: Bytes) -> Self {
78        self.unknown_tagged_fields.insert(key, value);
79        self
80    }
81}
82
83#[cfg(feature = "client")]
84impl Encodable for EnvelopeRequest {
85    fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()> {
86        types::CompactBytes.encode(buf, &self.request_data)?;
87        types::CompactBytes.encode(buf, &self.request_principal)?;
88        types::CompactBytes.encode(buf, &self.client_host_address)?;
89        let num_tagged_fields = self.unknown_tagged_fields.len();
90        if num_tagged_fields > std::u32::MAX as usize {
91            bail!(
92                "Too many tagged fields to encode ({} fields)",
93                num_tagged_fields
94            );
95        }
96        types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
97
98        write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
99        Ok(())
100    }
101    fn compute_size(&self, version: i16) -> Result<usize> {
102        let mut total_size = 0;
103        total_size += types::CompactBytes.compute_size(&self.request_data)?;
104        total_size += types::CompactBytes.compute_size(&self.request_principal)?;
105        total_size += types::CompactBytes.compute_size(&self.client_host_address)?;
106        let num_tagged_fields = self.unknown_tagged_fields.len();
107        if num_tagged_fields > std::u32::MAX as usize {
108            bail!(
109                "Too many tagged fields to encode ({} fields)",
110                num_tagged_fields
111            );
112        }
113        total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
114
115        total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
116        Ok(total_size)
117    }
118}
119
120#[cfg(feature = "broker")]
121impl Decodable for EnvelopeRequest {
122    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
123        let request_data = types::CompactBytes.decode(buf)?;
124        let request_principal = types::CompactBytes.decode(buf)?;
125        let client_host_address = types::CompactBytes.decode(buf)?;
126        let mut unknown_tagged_fields = BTreeMap::new();
127        let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
128        for _ in 0..num_tagged_fields {
129            let tag: u32 = types::UnsignedVarInt.decode(buf)?;
130            let size: u32 = types::UnsignedVarInt.decode(buf)?;
131            let unknown_value = buf.try_get_bytes(size as usize)?;
132            unknown_tagged_fields.insert(tag as i32, unknown_value);
133        }
134        Ok(Self {
135            request_data,
136            request_principal,
137            client_host_address,
138            unknown_tagged_fields,
139        })
140    }
141}
142
143impl Default for EnvelopeRequest {
144    fn default() -> Self {
145        Self {
146            request_data: Default::default(),
147            request_principal: Some(Default::default()),
148            client_host_address: Default::default(),
149            unknown_tagged_fields: BTreeMap::new(),
150        }
151    }
152}
153
154impl Message for EnvelopeRequest {
155    const VERSIONS: VersionRange = VersionRange { min: 0, max: 0 };
156    const DEPRECATED_VERSIONS: Option<VersionRange> = None;
157}
158
159impl HeaderVersion for EnvelopeRequest {
160    fn header_version(version: i16) -> i16 {
161        2
162    }
163}
kafka_protocol/messages/envelope_request.rs

kafka_protocol/messages/
envelope_request.rs
