Struct KinesisPublisher 

pub struct KinesisPublisher { /* private fields */ }

Publishes records to Kinesis streams; the destination is the stream’s name.

The record’s partition key is the unit of shard routing and per-key ordering. A publish names it with partition_key on the publish builder; a record that names none takes the key the mount site named on the policy (KinesisPublish::partition_key), and without that a process-unique key spreads the records across the shards. User headers beyond the partition key travel in a small conditional envelope (Kinesis records carry only a data blob and a partition key); plain payloads stay unenveloped, so any Kinesis consumer reads them, and a record from another producer reads back as headerless. The envelope is the magic RSK2, a big-endian u32 length of the header block, the block, and the payload; each header is a u32-prefixed name and a u32-prefixed value, so a value comes back byte for byte. Records in the earlier RSK1 text envelope still read back with their headers. One publish is one PutRecord call. Buildable before connect and usable until shutdown; afterwards every publish reports KinesisError::NotConnected.

Trait Implementations

impl Clone for KinesisPublisher

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KinesisPublisher

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

Formats the value using the given formatter.

impl Publisher for KinesisPublisher

type Payload = Take

A record’s data is a Blob, a vector the client keeps for the request, so the publisher takes the buffer the framework wrote: a publish that carries no header hands it straight through, and one that does spends it as the body of the envelope.

type Options = KinesisPublishOptions

The partition key is the one setting a Kinesis record varies per message, and KinesisPublishSteps is where a call site sets it.

type Error = KinesisError

The error type returned by publish.

async fn publish( &self, msg: OutgoingFor<'_, Take>, options: Option<&Self::Options>, ) -> Result<(), Self::Error>

Publishes a message to the broker, with the per-message settings the call site adjusted.

fn base_headers(&self) -> Option<&HeaderMap>

The headers this publisher contributes to every message it sends, underneath whatever the message itself names.