Skip to main content

PulsarBatchContext

Struct PulsarBatchContext 

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

The subscription-scoped batch context of a Pulsar subscription: its seeker, shared by every delivery of the batch.

The runtime builds one per dispatched batch from the batch’s first delivery (see BuildBatchContext), and a batch body reads it by key - SeekHandle - through ctx.context(..). A Position has no place here: a batch spans many deliveries, so where to seek rides the elements themselves (a &[Message<H, T>] batch reads it off each element’s header contract). Keeping this a separate type from PulsarContext is what rejects a batch body asking for per-delivery fields at compile time.

Pulsar’s client hands over one delivery at a time, so a batch here is assembled on the client from the size the mount site’s batch(n) names. The body sees the same context, seeker and settlement as on a broker that batches on the wire.

§Examples

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

#[derive(Deserialize)]
struct Job {
    id: u64,
    rewind: bool,
}

/// A batch that carries the rewind marker replays the retained backlog once it is settled:
/// the next batch opens at the beginning of the log.
#[subscriber(PulsarSubscription::new("jobs.bulk", "bulk-workers"))]
async fn work(jobs: &[Job], ctx: &mut Context<'_, PulsarBatchContext>) -> HandlerOutcome {
    let first = jobs.first().map(|job| job.id);
    tracing::info!(count = jobs.len(), ?first, "jobs received");
    if jobs.iter().any(|job| job.rewind)
        && ctx
            .context(SeekHandle)
            .seek(PulsarPosition::earliest())
            .await
            .is_err()
    {
        return HandlerOutcome::retry();
    }
    HandlerOutcome::ack()
}

#[ruststream::app]
fn app() -> impl App {
    RustStream::new(AppInfo::new("jobs", "0.1.0")).with_broker(
        PulsarBroker::new("pulsar://localhost:6650"),
        |b| {
            b.include(work.batch(nonzero!(100)));
        },
    )
}

Trait Implementations§

Source§

impl BuildBatchContext<PulsarMessage> for PulsarBatchContext

Source§

fn build(first: &PulsarMessage) -> Self

Builds the context value by reading subscription-scoped fields out of the batch’s first delivery, or out of the batch itself where it lends its values as one slice.
Source§

impl Debug for PulsarBatchContext

Source§

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

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

impl Field<PulsarBatchContext> for SeekHandle

Source§

type Value<'a> = &'a PulsarSeeker

The value read through this key, borrowed from the source for 'a.
Source§

fn get(self, src: &PulsarBatchContext) -> &PulsarSeeker

Reads this key’s field out of src.

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> 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, 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