Struct kafka_protocol::messages::join_group_response::JoinGroupResponse

#[non_exhaustive]
pub struct JoinGroupResponse {
    pub throttle_time_ms: i32,
    pub error_code: i16,
    pub generation_id: i32,
    pub protocol_type: Option<StrBytes>,
    pub protocol_name: Option<StrBytes>,
    pub leader: StrBytes,
    pub skip_assignment: bool,
    pub member_id: StrBytes,
    pub members: Vec<JoinGroupResponseMember>,
    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
}

Valid versions: 0-9

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

The 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: 2-9

error_code: i16

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

Supported API versions: 0-9

generation_id: i32

The generation ID of the group.

Supported API versions: 0-9

protocol_type: Option<StrBytes>

The group protocol name.

Supported API versions: 7-9

protocol_name: Option<StrBytes>

The group protocol selected by the coordinator.

Supported API versions: 0-9

leader: StrBytes

The leader of the group.

Supported API versions: 0-9

skip_assignment: bool

True if the leader must skip running the assignment.

Supported API versions: 9

member_id: StrBytes

The member ID assigned by the group coordinator.

Supported API versions: 0-9

members: Vec<JoinGroupResponseMember>

Supported API versions: 0-9

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl JoinGroupResponse

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

Sets throttle_time_ms to the passed value.

The 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: 2-9

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

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

Sets generation_id to the passed value.

The generation ID of the group.

Supported API versions: 0-9

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

Sets protocol_type to the passed value.

The group protocol name.

Supported API versions: 7-9

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

Sets protocol_name to the passed value.

The group protocol selected by the coordinator.

Supported API versions: 0-9

pub fn with_leader(self, value: StrBytes) -> Self

Sets leader to the passed value.

The leader of the group.

Supported API versions: 0-9

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

Sets skip_assignment to the passed value.

True if the leader must skip running the assignment.

Supported API versions: 9

pub fn with_member_id(self, value: StrBytes) -> Self

Sets member_id to the passed value.

The member ID assigned by the group coordinator.

Supported API versions: 0-9

pub fn with_members(self, value: Vec<JoinGroupResponseMember>) -> Self

Sets members to the passed value.

Supported API versions: 0-9

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 JoinGroupResponse

fn clone(&self) -> JoinGroupResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JoinGroupResponse

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

Formats the value using the given formatter.

impl Decodable for JoinGroupResponse

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

Decode the message from the provided buffer and version.

impl Default for JoinGroupResponse

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for JoinGroupResponse

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

fn from(value: JoinGroupResponse) -> ResponseKind

Converts to this type from the input type.

impl HeaderVersion for JoinGroupResponse

fn header_version(version: i16) -> i16

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

impl Message for JoinGroupResponse

const VERSIONS: VersionRange = _

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for JoinGroupResponse

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