Struct DescribedGroup

#[non_exhaustive]
pub struct DescribedGroup {
    pub error_code: i16,
    pub group_id: GroupId,
    pub group_state: StrBytes,
    pub protocol_type: StrBytes,
    pub protocol_data: StrBytes,
    pub members: Vec<DescribedGroupMember>,
    pub authorized_operations: i32,
    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
}

Valid versions: 0-5

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 describe error, or 0 if there was no error.

Supported API versions: 0-5

group_id: GroupId

The group ID string.

Supported API versions: 0-5

group_state: StrBytes

The group state string, or the empty string.

Supported API versions: 0-5

protocol_type: StrBytes

The group protocol type, or the empty string.

Supported API versions: 0-5

protocol_data: StrBytes

The group protocol data, or the empty string.

Supported API versions: 0-5

members: Vec<DescribedGroupMember>

The group members.

Supported API versions: 0-5

authorized_operations: i32

32-bit bitfield to represent authorized operations for this group.

Supported API versions: 3-5

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl DescribedGroup

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

Sets error_code to the passed value.

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

Supported API versions: 0-5

pub fn with_group_id(self, value: GroupId) -> Self

Sets group_id to the passed value.

The group ID string.

Supported API versions: 0-5

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

Sets group_state to the passed value.

The group state string, or the empty string.

Supported API versions: 0-5

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

Sets protocol_type to the passed value.

The group protocol type, or the empty string.

Supported API versions: 0-5

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

Sets protocol_data to the passed value.

The group protocol data, or the empty string.

Supported API versions: 0-5

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

Sets members to the passed value.

The group members.

Supported API versions: 0-5

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

Sets authorized_operations to the passed value.

32-bit bitfield to represent authorized operations for this group.

Supported API versions: 3-5

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 DescribedGroup

fn clone(&self) -> DescribedGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribedGroup

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

Formats the value using the given formatter.

impl Decodable for DescribedGroup

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 DescribedGroup

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for DescribedGroup

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 Message for DescribedGroup

const VERSIONS: VersionRange

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for DescribedGroup

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