Struct PartitionData

#[non_exhaustive]
pub struct PartitionData {
    pub partition_index: i32,
    pub error_code: i16,
    pub high_watermark: i64,
    pub last_stable_offset: i64,
    pub log_start_offset: i64,
    pub diverging_epoch: EpochEndOffset,
    pub current_leader: LeaderIdAndEpoch,
    pub snapshot_id: SnapshotId,
    pub aborted_transactions: Option<Vec<AbortedTransaction>>,
    pub preferred_read_replica: BrokerId,
    pub records: Option<Bytes>,
    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
}

Valid versions: 0-17

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.

partition_index: i32

The partition index.

Supported API versions: 0-17

error_code: i16

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

Supported API versions: 0-17

high_watermark: i64

The current high water mark.

Supported API versions: 0-17

last_stable_offset: i64

The last stable offset (or LSO) of the partition. This is the last offset such that the state of all transactional records prior to this offset have been decided (ABORTED or COMMITTED)

Supported API versions: 4-17

log_start_offset: i64

The current log start offset.

Supported API versions: 5-17

diverging_epoch: EpochEndOffset

In case divergence is detected based on the LastFetchedEpoch and FetchOffset in the request, this field indicates the largest epoch and its end offset such that subsequent records are known to diverge

Supported API versions: 12-17

current_leader: LeaderIdAndEpoch

Supported API versions: 12-17

snapshot_id: SnapshotId

In the case of fetching an offset less than the LogStartOffset, this is the end offset and epoch that should be used in the FetchSnapshot request.

Supported API versions: 12-17

aborted_transactions: Option<Vec<AbortedTransaction>>

The aborted transactions.

Supported API versions: 4-17

preferred_read_replica: BrokerId

The preferred read replica for the consumer to use on its next fetch request

Supported API versions: 11-17

records: Option<Bytes>

The record data.

Supported API versions: 0-17

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl PartitionData

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

Sets partition_index to the passed value.

The partition index.

Supported API versions: 0-17

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 fetch error.

Supported API versions: 0-17

pub fn with_high_watermark(self, value: i64) -> Self

Sets high_watermark to the passed value.

The current high water mark.

Supported API versions: 0-17

pub fn with_last_stable_offset(self, value: i64) -> Self

Sets last_stable_offset to the passed value.

The last stable offset (or LSO) of the partition. This is the last offset such that the state of all transactional records prior to this offset have been decided (ABORTED or COMMITTED)

Supported API versions: 4-17

pub fn with_log_start_offset(self, value: i64) -> Self

Sets log_start_offset to the passed value.

The current log start offset.

Supported API versions: 5-17

pub fn with_diverging_epoch(self, value: EpochEndOffset) -> Self

Sets diverging_epoch to the passed value.

In case divergence is detected based on the LastFetchedEpoch and FetchOffset in the request, this field indicates the largest epoch and its end offset such that subsequent records are known to diverge

Supported API versions: 12-17

pub fn with_current_leader(self, value: LeaderIdAndEpoch) -> Self

Sets current_leader to the passed value.

Supported API versions: 12-17

pub fn with_snapshot_id(self, value: SnapshotId) -> Self

Sets snapshot_id to the passed value.

In the case of fetching an offset less than the LogStartOffset, this is the end offset and epoch that should be used in the FetchSnapshot request.

Supported API versions: 12-17

pub fn with_aborted_transactions( self, value: Option<Vec<AbortedTransaction>>, ) -> Self

Sets aborted_transactions to the passed value.

The aborted transactions.

Supported API versions: 4-17

pub fn with_preferred_read_replica(self, value: BrokerId) -> Self

Sets preferred_read_replica to the passed value.

The preferred read replica for the consumer to use on its next fetch request

Supported API versions: 11-17

pub fn with_records(self, value: Option<Bytes>) -> Self

Sets records to the passed value.

The record data.

Supported API versions: 0-17

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 PartitionData

fn clone(&self) -> PartitionData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PartitionData

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

Formats the value using the given formatter.

impl Decodable for PartitionData

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 PartitionData

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for PartitionData

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 PartitionData

const VERSIONS: VersionRange

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for PartitionData

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