Struct SaslAuthenticateResponse

#[non_exhaustive]
pub struct SaslAuthenticateResponse {
    pub error_code: i16,
    pub error_message: Option<StrBytes>,
    pub auth_bytes: Bytes,
    pub session_lifetime_ms: i64,
    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
}

Valid versions: 0-2

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

error_code: i16

The error code, or 0 if there was no error.

Supported API versions: 0-2

error_message: Option<StrBytes>

The error message, or null if there was no error.

Supported API versions: 0-2

auth_bytes: Bytes

The SASL authentication bytes from the server, as defined by the SASL mechanism.

Supported API versions: 0-2

session_lifetime_ms: i64

Number of milliseconds after which only re-authentication over the existing connection to create a new session can occur.

Supported API versions: 1-2

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl SaslAuthenticateResponse

pub fn with_error_code(self, value: i16) -> Self

Sets error_code to the passed value.

The error code, or 0 if there was no error.

Supported API versions: 0-2

pub fn with_error_message(self, value: Option<StrBytes>) -> Self

Sets error_message to the passed value.

The error message, or null if there was no error.

Supported API versions: 0-2

pub fn with_auth_bytes(self, value: Bytes) -> Self

Sets auth_bytes to the passed value.

The SASL authentication bytes from the server, as defined by the SASL mechanism.

Supported API versions: 0-2

pub fn with_session_lifetime_ms(self, value: i64) -> Self

Sets session_lifetime_ms to the passed value.

Number of milliseconds after which only re-authentication over the existing connection to create a new session can occur.

Supported API versions: 1-2

pub fn with_unknown_tagged_fields(self, value: BTreeMap<i32, Bytes>) -> Self

Sets unknown_tagged_fields to the passed value.

pub fn with_unknown_tagged_field(self, key: i32, value: Bytes) -> Self

Inserts an entry into unknown_tagged_fields.

Trait Implementations

impl Clone for SaslAuthenticateResponse

fn clone(&self) -> SaslAuthenticateResponse

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SaslAuthenticateResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Decodable for SaslAuthenticateResponse

Available on crate feature client only.

fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self>

Decode the message from the provided buffer and version.

impl Default for SaslAuthenticateResponse

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for SaslAuthenticateResponse

Available on crate feature broker only.

fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()>

Encode the message into the target buffer.

fn compute_size(&self, version: i16) -> Result<usize>

Compute the total size of the message when encoded.

impl From<SaslAuthenticateResponse> for ResponseKind

Available on crate feature messages_enums only.

fn from(value: SaslAuthenticateResponse) -> ResponseKind

Converts to this type from the input type.

impl HeaderVersion for SaslAuthenticateResponse

fn header_version(version: i16) -> i16

Maps a header version to a given version for a particular API message.

impl Message for SaslAuthenticateResponse

const VERSIONS: VersionRange

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for SaslAuthenticateResponse

fn eq(&self, other: &SaslAuthenticateResponse) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SaslAuthenticateResponse