Struct PartitionSnapshot

#[non_exhaustive]
pub struct PartitionSnapshot {
    pub index: i32,
    pub error_code: i16,
    pub snapshot_id: SnapshotId,
    pub current_leader: LeaderIdAndEpoch,
    pub size: i64,
    pub position: i64,
    pub unaligned_records: Bytes,
    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.

index: i32

The partition index.

Supported API versions: 0-1

error_code: i16

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

Supported API versions: 0-1

snapshot_id: SnapshotId

The snapshot endOffset and epoch fetched

Supported API versions: 0-1

current_leader: LeaderIdAndEpoch

Supported API versions: 0-1

size: i64

The total size of the snapshot.

Supported API versions: 0-1

position: i64

The starting byte position within the snapshot included in the Bytes field.

Supported API versions: 0-1

unaligned_records: Bytes

Snapshot data in records format which may not be aligned on an offset boundary

Supported API versions: 0-1

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl PartitionSnapshot

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

Sets index to the passed value.

The partition index.

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

Supported API versions: 0-1

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

Sets snapshot_id to the passed value.

The snapshot endOffset and epoch fetched

Supported API versions: 0-1

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

Sets current_leader to the passed value.

Supported API versions: 0-1

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

Sets size to the passed value.

The total size of the snapshot.

Supported API versions: 0-1

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

Sets position to the passed value.

The starting byte position within the snapshot included in the Bytes field.

Supported API versions: 0-1

pub fn with_unaligned_records(self, value: Bytes) -> Self

Sets unaligned_records to the passed value.

Snapshot data in records format which may not be aligned on an offset boundary

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 PartitionSnapshot

fn clone(&self) -> PartitionSnapshot

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PartitionSnapshot

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

Formats the value using the given formatter.

impl Decodable for PartitionSnapshot

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 PartitionSnapshot

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for PartitionSnapshot

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 PartitionSnapshot

const VERSIONS: VersionRange

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for PartitionSnapshot

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