Skip to main content

PulsarPosition

Enum PulsarPosition 

Source
pub enum PulsarPosition {
    Earliest,
    Latest,
    MessageId(MessageIdData),
    Timestamp(u64),
}
Expand description

A position in a topic’s retained log, accepted by Seeker::seek.

Captured positions (Positioned::position) carry the pinned semantics the framework defines: seeking to one redelivers exactly that message. The timestamp form keeps the broker’s own publish-time semantics instead.

The constructors exist because the start_at(..) clause of #[subscriber] recovers the position type from the constructor path; a bare variant path does not name its type in the tokens the macro sees.

§Examples

use ruststream_pulsar::prelude::*;
use serde::Deserialize;

#[derive(Deserialize)]
struct Tick {
    price: f64,
    replay_from: Option<u64>,
}

/// A price board: the backlog is stale on startup, so the subscription opens at the tip, and
/// a tick that asks for a replay rewinds it to a point in time.
#[subscriber(
    PulsarSubscription::new("ticks", "board"),
    start_at(PulsarPosition::latest())
)]
async fn show(tick: &Tick, Ctx(seeker): Ctx<SeekHandle>) -> HandlerOutcome {
    tracing::info!(price = tick.price, "tick shown");
    if let Some(millis) = tick.replay_from
        && seeker.seek(PulsarPosition::timestamp(millis)).await.is_err()
    {
        return HandlerOutcome::retry();
    }
    HandlerOutcome::ack()
}

Variants§

§

Earliest

The beginning of the log: every message the topics still retain is redelivered.

This is a seek, not the server-side initial position, which Pulsar applies only when a subscription is first created. A subscription is durable broker-side state, so a start_at(PulsarPosition::earliest()) clause rewinds an existing subscription’s cursor on every startup, replaying the retained backlog each time the service starts.

§

Latest

The tip of the log: only messages published after the seek are delivered.

§

MessageId(MessageIdData)

The position of a delivered message.

§

Timestamp(u64)

Publish time, in milliseconds since the Unix epoch.

Implementations§

Source§

impl PulsarPosition

Source

pub fn earliest() -> Self

The beginning of the log; see PulsarPosition::Earliest for how it interacts with a durable subscription’s cursor.

§Examples
use ruststream_pulsar::prelude::*;
use serde::Deserialize;

#[derive(Deserialize)]
struct Job {
    id: u64,
    resume_at: Option<u64>,
}

/// Reads the whole retained backlog on every startup, and skips forward past a region the
/// producer marked poisoned.
#[subscriber(
    PulsarSubscription::pattern("persistent://public/default/orders-.*", "audit"),
    start_at(PulsarPosition::earliest())
)]
async fn audit(job: &Job, Ctx(seeker): Ctx<SeekHandle>) -> HandlerOutcome {
    tracing::info!(job.id, "audited");
    if let Some(millis) = job.resume_at
        && seeker.seek(PulsarPosition::timestamp(millis)).await.is_err()
    {
        return HandlerOutcome::retry();
    }
    HandlerOutcome::ack()
}
Source

pub fn latest() -> Self

The tip of the log; see PulsarPosition::Latest.

Source

pub fn timestamp(millis: u64) -> Self

A publish time, in milliseconds since the Unix epoch; see PulsarPosition::Timestamp.

Trait Implementations§

Source§

impl Clone for PulsarPosition

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 PulsarPosition

Source§

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

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

impl Eq for PulsarPosition

Source§

impl PartialEq for PulsarPosition

Source§

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

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> PublishedThrough<DefaultSlot> for T

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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