Struct KinesisStream 

pub struct KinesisStream { /* private fields */ }

A subscription descriptor for one Kinesis stream.

Every shard resumes from its stored checkpoint, and a shard without one starts at the tip. To open somewhere else, wrap the descriptor in the framework’s start_at(..) clause with a KinesisPosition.

Implements SubscriptionSource, so it can sit inline in the #[subscriber(..)] decorator:

use ruststream_kinesis::KinesisStream;

let source = KinesisStream::new("orders").batch(500);

Implementations

impl KinesisStream

pub fn new(stream: impl Into<String>) -> Self

Names the stream (name or ARN).

pub fn batch(self, batch: i32) -> Self

Records per read call (1..=10000). Defaults to 1000.

pub fn poll_interval(self, interval: Duration) -> Self

The pause between reads on an idle shard. Defaults to 1 second, the service’s own recommendation; lower values spend the 5-reads-per-second budget faster.

pub fn create_if_missing(self, shards: i32) -> Self

Creates the stream with shards provisioned shards on subscribe when it does not exist yet. Meant for local development and tests; production streams are usually managed as infrastructure.

pub fn stream(&self) -> &str

The stream name this descriptor resolves.

Trait Implementations

impl Clone for KinesisStream

fn clone(&self) -> KinesisStream

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KinesisStream

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

Formats the value using the given formatter.

impl Eq for KinesisStream

impl PartialEq for KinesisStream

fn eq(&self, other: &KinesisStream) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for KinesisStream

impl SubscriptionSource<ConnectedKinesisBroker> for KinesisStream

type Subscriber = KinesisSubscriber

The subscriber type this source opens.

fn name(&self) -> &str

The name (subject / channel) this subscription binds to.

async fn subscribe( self, connected: &ConnectedKinesisBroker, ) -> Result<KinesisSubscriber, KinesisError>

Opens the subscription against the connected broker. Called once at startup.