Skip to main content

KafkaPosition

Enum KafkaPosition 

Source
#[non_exhaustive]
pub enum KafkaPosition { Earliest, Latest, Timestamp(i64), Offset { topic: Option<String>, partition: i32, offset: i64, }, }
Expand description

Where a subscription should resume reading.

The stream-wide variants (Earliest, Latest, Timestamp) apply to every partition currently assigned to this consumer; Offset names one partition. Build them with the constructors (earliest, offset, …) - the variants are what the seeker matches on.

§Examples

use ruststream_rdkafka::KafkaPosition;

let replay_all = KafkaPosition::earliest();
let skip_ahead = KafkaPosition::offset(3, 1_024);
let since_noon = KafkaPosition::timestamp(1_767_000_000_000);

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Earliest

The earliest offset still retained, on every assigned partition.

§

Latest

The end of the log, on every assigned partition, as the broker reports it while the seek runs: records published after that point arrive normally, everything before is skipped.

§

Timestamp(i64)

The first record at or after this timestamp (epoch milliseconds), resolved per assigned partition. A partition with no such record resumes at its end.

§

Offset

An absolute offset on one partition.

Fields

§topic: Option<String>

The topic, when the position names one. Positioned captures the delivery’s own topic here; offset leaves it unset, which repositions that partition index on every assigned topic (one topic being the usual case).

§partition: i32

The partition to reposition.

§offset: i64

The offset to resume from: the record at this offset is delivered next.

Implementations§

Source§

impl KafkaPosition

Source

pub const fn earliest() -> Self

Every assigned partition, at the earliest retained offset.

Source

pub const fn latest() -> Self

Every assigned partition, at the end of the log.

Source

pub const fn offset(partition: i32, offset: i64) -> Self

One partition, at an absolute offset.

Source

pub fn topic_offset( topic: impl Into<String>, partition: i32, offset: i64, ) -> Self

One partition of one topic, at an absolute offset. The form a delivery’s position returns, and what a multi-topic subscription needs to name a partition unambiguously.

Source

pub const fn timestamp(when_millis: i64) -> Self

Every assigned partition, at the first record whose timestamp is at or after when_millis (epoch milliseconds).

Trait Implementations§

Source§

impl Clone for KafkaPosition

Source§

fn clone(&self) -> KafkaPosition

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 KafkaPosition

Source§

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

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

impl Eq for KafkaPosition

Source§

impl PartialEq for KafkaPosition

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for KafkaPosition

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> 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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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