Struct kafka_protocol::messages::broker_heartbeat_response::BrokerHeartbeatResponse

#[non_exhaustive]
pub struct BrokerHeartbeatResponse {
    pub throttle_time_ms: i32,
    pub error_code: i16,
    pub is_caught_up: bool,
    pub is_fenced: bool,
    pub should_shut_down: bool,
    pub unknown_tagged_fields: BTreeMap<i32, Vec<u8>>,
}

Valid versions: 0

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.

throttle_time_ms: i32

Duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota.

Supported API versions: 0

error_code: i16

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

Supported API versions: 0

is_caught_up: bool

True if the broker has approximately caught up with the latest metadata.

Supported API versions: 0

is_fenced: bool

True if the broker is fenced.

Supported API versions: 0

should_shut_down: bool

True if the broker should proceed with its shutdown.

Supported API versions: 0

unknown_tagged_fields: BTreeMap<i32, Vec<u8>>

Other tagged fields

Trait Implementations

impl Builder for BrokerHeartbeatResponse

type Builder = BrokerHeartbeatResponseBuilder

The [derive_builder::Builder] type for this protocol item.

fn builder() -> Self::Builder

Retrieve the builder for this protocol item.

impl Clone for BrokerHeartbeatResponse

fn clone(&self) -> BrokerHeartbeatResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BrokerHeartbeatResponse

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

Formats the value using the given formatter.

impl Decodable for BrokerHeartbeatResponse

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

Decode the message from the provided buffer and version.

impl Default for BrokerHeartbeatResponse

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for BrokerHeartbeatResponse

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

Encode the message into the target buffer.

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

Compute the total size of the message when encoded.

impl HeaderVersion for BrokerHeartbeatResponse

fn header_version(version: i16) -> i16

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

impl Message for BrokerHeartbeatResponse

const VERSIONS: VersionRange = _

The valid versions for this message.

impl PartialEq<BrokerHeartbeatResponse> for BrokerHeartbeatResponse

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for BrokerHeartbeatResponse