Struct FetchSnapshotRequest

#[non_exhaustive]
pub struct FetchSnapshotRequest {
    pub cluster_id: Option<StrBytes>,
    pub replica_id: BrokerId,
    pub max_bytes: i32,
    pub topics: Vec<TopicSnapshot>,
    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.

cluster_id: Option<StrBytes>

The clusterId if known, this is used to validate metadata fetches prior to broker registration

Supported API versions: 0-1

replica_id: BrokerId

The broker ID of the follower

Supported API versions: 0-1

max_bytes: i32

The maximum bytes to fetch from all of the snapshots

Supported API versions: 0-1

topics: Vec<TopicSnapshot>

The topics to fetch

Supported API versions: 0-1

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl FetchSnapshotRequest

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

Sets cluster_id to the passed value.

The clusterId if known, this is used to validate metadata fetches prior to broker registration

Supported API versions: 0-1

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

Sets replica_id to the passed value.

The broker ID of the follower

Supported API versions: 0-1

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

Sets max_bytes to the passed value.

The maximum bytes to fetch from all of the snapshots

Supported API versions: 0-1

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

Sets topics to the passed value.

The topics to fetch

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 FetchSnapshotRequest

fn clone(&self) -> FetchSnapshotRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FetchSnapshotRequest

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

Formats the value using the given formatter.

impl Decodable for FetchSnapshotRequest

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 FetchSnapshotRequest

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for FetchSnapshotRequest

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<FetchSnapshotRequest> for RequestKind

Available on crate feature messages_enums only.

fn from(value: FetchSnapshotRequest) -> RequestKind

Converts to this type from the input type.

impl HeaderVersion for FetchSnapshotRequest

fn header_version(version: i16) -> i16

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

impl Message for FetchSnapshotRequest

const VERSIONS: VersionRange

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for FetchSnapshotRequest

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

Available on crate features client and broker only.

const KEY: i16 = 59i16

The API key of this request.

type Response = FetchSnapshotResponse

The response associated with this request.

impl StructuralPartialEq for FetchSnapshotRequest