Struct 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, Bytes>,
}

Valid versions: 0-1

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-1

error_code: i16

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

Supported API versions: 0-1

is_caught_up: bool

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

Supported API versions: 0-1

is_fenced: bool

True if the broker is fenced.

Supported API versions: 0-1

should_shut_down: bool

True if the broker should proceed with its shutdown.

Supported API versions: 0-1

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl BrokerHeartbeatResponse

pub fn with_throttle_time_ms(self, value: i32) -> Self

Sets throttle_time_ms to the passed value.

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-1

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-1

pub fn with_is_caught_up(self, value: bool) -> Self

Sets is_caught_up to the passed value.

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

Supported API versions: 0-1

pub fn with_is_fenced(self, value: bool) -> Self

Sets is_fenced to the passed value.

True if the broker is fenced.

Supported API versions: 0-1

pub fn with_should_shut_down(self, value: bool) -> Self

Sets should_shut_down to the passed value.

True if the broker should proceed with its shutdown.

Supported API versions: 0-1

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 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

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 BrokerHeartbeatResponse

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for BrokerHeartbeatResponse

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<BrokerHeartbeatResponse> for ResponseKind

Available on crate feature messages_enums only.

fn from(value: BrokerHeartbeatResponse) -> ResponseKind

Converts to this type from the input type.

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.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for BrokerHeartbeatResponse

fn eq(&self, other: &BrokerHeartbeatResponse) -> 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 BrokerHeartbeatResponse