Struct kafka_protocol::messages::produce_request::ProduceRequest

#[non_exhaustive]
pub struct ProduceRequest {
    pub transactional_id: Option<TransactionalId>,
    pub acks: i16,
    pub timeout_ms: i32,
    pub topic_data: IndexMap<TopicName, TopicProduceData>,
    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
}

Valid versions: 0-10

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.

transactional_id: Option<TransactionalId>

The transactional ID, or null if the producer is not transactional.

Supported API versions: 3-10

acks: i16

The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments, 1 for only the leader and -1 for the full ISR.

Supported API versions: 0-10

timeout_ms: i32

The timeout to await a response in milliseconds.

Supported API versions: 0-10

topic_data: IndexMap<TopicName, TopicProduceData>

Each topic to produce to.

Supported API versions: 0-10

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl ProduceRequest

pub fn with_transactional_id(self, value: Option<TransactionalId>) -> Self

Sets transactional_id to the passed value.

The transactional ID, or null if the producer is not transactional.

Supported API versions: 3-10

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

Sets acks to the passed value.

The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments, 1 for only the leader and -1 for the full ISR.

Supported API versions: 0-10

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

Sets timeout_ms to the passed value.

The timeout to await a response in milliseconds.

Supported API versions: 0-10

pub fn with_topic_data( self, value: IndexMap<TopicName, TopicProduceData>, ) -> Self

Sets topic_data to the passed value.

Each topic to produce to.

Supported API versions: 0-10

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 ProduceRequest

fn clone(&self) -> ProduceRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProduceRequest

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

Formats the value using the given formatter.

impl Decodable for ProduceRequest

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

Decode the message from the provided buffer and version.

impl Default for ProduceRequest

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for ProduceRequest

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

fn from(value: ProduceRequest) -> RequestKind

Converts to this type from the input type.

impl HeaderVersion for ProduceRequest

fn header_version(version: i16) -> i16

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

impl Message for ProduceRequest

const VERSIONS: VersionRange = _

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = _

The deprecated versions for this message.

impl PartialEq for ProduceRequest

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

const KEY: i16 = 0i16

The API key of this request.

type Response = ProduceResponse

The response associated with this request.

impl StructuralPartialEq for ProduceRequest