kafka_protocol/messages/
sasl_authenticate_request.rs

1//! SaslAuthenticateRequest
2//!
3//! See the schema for this message [here](https://github.com/apache/kafka/blob/trunk/clients/src/main/resources/common/message/SaslAuthenticateRequest.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-2
21#[non_exhaustive]
22#[derive(Debug, Clone, PartialEq)]
23pub struct SaslAuthenticateRequest {
24    /// The SASL authentication bytes from the client, as defined by the SASL mechanism.
25    ///
26    /// Supported API versions: 0-2
27    pub auth_bytes: Bytes,
28
29    /// Other tagged fields
30    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
31}
32
33impl SaslAuthenticateRequest {
34    /// Sets `auth_bytes` to the passed value.
35    ///
36    /// The SASL authentication bytes from the client, as defined by the SASL mechanism.
37    ///
38    /// Supported API versions: 0-2
39    pub fn with_auth_bytes(mut self, value: Bytes) -> Self {
40        self.auth_bytes = value;
41        self
42    }
43    /// Sets unknown_tagged_fields to the passed value.
44    pub fn with_unknown_tagged_fields(mut self, value: BTreeMap<i32, Bytes>) -> Self {
45        self.unknown_tagged_fields = value;
46        self
47    }
48    /// Inserts an entry into unknown_tagged_fields.
49    pub fn with_unknown_tagged_field(mut self, key: i32, value: Bytes) -> Self {
50        self.unknown_tagged_fields.insert(key, value);
51        self
52    }
53}
54
55#[cfg(feature = "client")]
56impl Encodable for SaslAuthenticateRequest {
57    fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()> {
58        if version >= 2 {
59            types::CompactBytes.encode(buf, &self.auth_bytes)?;
60        } else {
61            types::Bytes.encode(buf, &self.auth_bytes)?;
62        }
63        if version >= 2 {
64            let num_tagged_fields = self.unknown_tagged_fields.len();
65            if num_tagged_fields > std::u32::MAX as usize {
66                bail!(
67                    "Too many tagged fields to encode ({} fields)",
68                    num_tagged_fields
69                );
70            }
71            types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
72
73            write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
74        }
75        Ok(())
76    }
77    fn compute_size(&self, version: i16) -> Result<usize> {
78        let mut total_size = 0;
79        if version >= 2 {
80            total_size += types::CompactBytes.compute_size(&self.auth_bytes)?;
81        } else {
82            total_size += types::Bytes.compute_size(&self.auth_bytes)?;
83        }
84        if version >= 2 {
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            total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
93
94            total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
95        }
96        Ok(total_size)
97    }
98}
99
100#[cfg(feature = "broker")]
101impl Decodable for SaslAuthenticateRequest {
102    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
103        let auth_bytes = if version >= 2 {
104            types::CompactBytes.decode(buf)?
105        } else {
106            types::Bytes.decode(buf)?
107        };
108        let mut unknown_tagged_fields = BTreeMap::new();
109        if version >= 2 {
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        }
118        Ok(Self {
119            auth_bytes,
120            unknown_tagged_fields,
121        })
122    }
123}
124
125impl Default for SaslAuthenticateRequest {
126    fn default() -> Self {
127        Self {
128            auth_bytes: Default::default(),
129            unknown_tagged_fields: BTreeMap::new(),
130        }
131    }
132}
133
134impl Message for SaslAuthenticateRequest {
135    const VERSIONS: VersionRange = VersionRange { min: 0, max: 2 };
136    const DEPRECATED_VERSIONS: Option<VersionRange> = None;
137}
138
139impl HeaderVersion for SaslAuthenticateRequest {
140    fn header_version(version: i16) -> i16 {
141        if version >= 2 {
142            2
143        } else {
144            1
145        }
146    }
147}
kafka_protocol/messages/sasl_authenticate_request.rs

kafka_protocol/messages/
sasl_authenticate_request.rs
