Struct OffsetFetchRequest

#[non_exhaustive]
pub struct OffsetFetchRequest {
    pub group_id: GroupId,
    pub topics: Option<Vec<OffsetFetchRequestTopic>>,
    pub groups: Vec<OffsetFetchRequestGroup>,
    pub require_stable: bool,
    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.

group_id: GroupId

The group to fetch offsets for.

Supported API versions: 0-7

topics: Option<Vec<OffsetFetchRequestTopic>>

Each topic we would like to fetch offsets for, or null to fetch offsets for all topics.

Supported API versions: 0-7

groups: Vec<OffsetFetchRequestGroup>

Each group we would like to fetch offsets for

Supported API versions: 8-9

require_stable: bool

Whether broker should hold on returning unstable offsets but set a retriable error code for the partitions.

Supported API versions: 7-9

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl OffsetFetchRequest

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

Sets group_id to the passed value.

The group to fetch offsets for.

Supported API versions: 0-7

pub fn with_topics(self, value: Option<Vec<OffsetFetchRequestTopic>>) -> Self

Sets topics to the passed value.

Each topic we would like to fetch offsets for, or null to fetch offsets for all topics.

Supported API versions: 0-7

pub fn with_groups(self, value: Vec<OffsetFetchRequestGroup>) -> Self

Sets groups to the passed value.

Each group we would like to fetch offsets for

Supported API versions: 8-9

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

Sets require_stable to the passed value.

Whether broker should hold on returning unstable offsets but set a retriable error code for the partitions.

Supported API versions: 7-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 OffsetFetchRequest

fn clone(&self) -> OffsetFetchRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OffsetFetchRequest

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

Formats the value using the given formatter.

impl Decodable for OffsetFetchRequest

Available on crate feature broker only.

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

Decode the message from the provided buffer and version.

impl Default for OffsetFetchRequest

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for OffsetFetchRequest

Available on crate feature client 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<OffsetFetchRequest> for RequestKind

Available on crate feature messages_enums only.

fn from(value: OffsetFetchRequest) -> RequestKind

Converts to this type from the input type.

impl HeaderVersion for OffsetFetchRequest

fn header_version(version: i16) -> i16

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

impl Message for OffsetFetchRequest

const VERSIONS: VersionRange

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange>

The deprecated versions for this message.

impl PartialEq for OffsetFetchRequest

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

Available on crate features client and broker only.

const KEY: i16 = 9i16

The API key of this request.

type Response = OffsetFetchResponse

The response associated with this request.

impl StructuralPartialEq for OffsetFetchRequest