Skip to main content

KafkaPartitions

Struct KafkaPartitions 

Source
pub struct KafkaPartitions { /* private fields */ }
Expand description

A subscription that takes exactly the partitions it names, without joining a consumer group and without rebalancing.

That fits a reader pinned to a partition, an inspection or replay tool, and a one-consumer-per-partition deployment. A group stays optional and changes only how offsets are handled: with one named the consumer commits into the group without joining it, and without one commits are off, so the start offset has to be explicit.

This form reads a subset of a topic, and the partitioner places a published record wherever the key sends it, so no publish addresses it: a registration that retries names the destination itself with .out_retry(policy).to("orders.retry"). Reading the whole topic is KafkaTopic, which addresses its own copies.

§Examples

An inspection reader pinned to partition 0, with no group side effects:

use ruststream_rdkafka::context::keys::Offset;
use ruststream_rdkafka::prelude::*;

#[subscriber(KafkaPartitions::new("orders", [0]).start(StartOffset::Earliest))]
async fn inspect(order: &Order, Ctx(offset): Ctx<Offset>) -> HandlerOutcome {
    tracing::info!(order.id, %offset, "read from partition 0");
    HandlerOutcome::ack()
}

fn app() -> RustStream {
    RustStream::new(AppInfo::new("inspector", "0.1.0"))
        .with_broker(KafkaBroker::new(["localhost:9092"]), |b| {
            b.include(inspect);
        })
}

Implementations§

Source§

impl KafkaPartitions

Source

pub fn new( topic: impl Into<String>, partitions: impl IntoIterator<Item = i32>, ) -> Self

Describes a reader over exactly partitions of topic.

Source

pub fn group(self, group: impl Into<String>) -> Self

The consumer group whose committed offsets this reader uses, overriding KafkaBroker::default_group. The reader commits into the group without ever joining it.

Source

pub fn start(self, start: StartOffset) -> Self

Where the reader starts (see StartOffset). Without a group, StartOffset::Committed has nothing to resume from and is a startup error.

Source

pub fn commit(self, commit: Commit) -> Self

How processed deliveries are committed (see Commit). Commit::Transactional is a startup error here: an exactly-once pipeline commits through the consumer-group protocol this form does not take part in.

Source

pub fn lane_key(self, lane_key: LaneKey) -> Self

What drives keyed worker lanes for this reader (see LaneKey). Under the default each assigned partition gets a lane of its own.

Source

pub fn config(self, key: impl Into<String>, value: impl Into<String>) -> Self

Raw librdkafka consumer property passthrough, applied last (it wins over the typed options and the broker-wide config).

A property the subscription’s Commit mode owns is the exception; see KafkaTopic::config.

Source

pub fn topic(&self) -> &str

The topic these partitions belong to, which is also the handler metadata name.

Source

pub fn partitions(&self) -> &[i32]

The partitions this reader takes.

Trait Implementations§

Source§

impl Clone for KafkaPartitions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KafkaPartitions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl IntoSource for KafkaPartitions

Source§

type Source = KafkaPartitions

The source the constructor stores.
Source§

fn into_source(self) -> Self

Builds the source.
Source§

impl SubscriptionSource<ConnectedKafkaBroker> for KafkaPartitions

Source§

type Subscriber = KafkaSubscriber

The subscriber type this source opens.
Source§

type Copies = NamedCopies

Who publishes the copies this subscription’s retries are made of, and who names where they go: AddressedCopies, NamedCopies or BrokerMoves. Read more
Source§

fn name(&self) -> &str

The name (subject / channel) this subscription binds to. Read more
Source§

async fn subscribe( self, connected: &ConnectedKafkaBroker, ) -> Result<Self::Subscriber, KafkaError>

Opens the subscription against the connected broker. Called once at startup. Read more
Source§

fn channel_bindings(&self) -> Bindings

What this subscription adds to its channel in the generated AsyncAPI document. Read more
Source§

fn operation_bindings(&self) -> Bindings

What this subscription adds to its receive operation in the document. Read more
Source§

fn declare_retry(self, declaration: &RetryDeclaration) -> Self
where Self: Sized,

Takes the registration’s retry declaration into the descriptor, before the subscription opens. Read more
Source§

fn declare_retry_on( &self, connected: &C, declaration: &RetryDeclaration, ) -> Result<(), DeclareRetryError>

Carries the registration’s declaration to the broker, at the same point and before the subscription opens. Read more
Source§

fn message_bindings(&self) -> Bindings

What this subscription adds to the messages that arrive on it. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> PublishedThrough<DefaultSlot> for T

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more