Skip to main content

PulsarSubscription

Struct PulsarSubscription 

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

A subscription descriptor for one Pulsar subscription over one or more topics.

Where the subscription starts reading is not a descriptor option: it is the framework’s start_at(..) clause over PulsarPosition, which the Seekable capability backs.

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

use std::time::Duration;
use ruststream_pulsar::{DeadLetter, PulsarSubscription, SubscriptionType};

let source = PulsarSubscription::new("orders", "workers")
    .subscription_type(SubscriptionType::Shared)
    .dead_letter(DeadLetter::new("orders-dlq").max_deliveries(5))
    .ack_timeout(Duration::from_secs(30));

Implementations§

Source§

impl PulsarSubscription

Source

pub fn new(topic: impl Into<String>, subscription: impl Into<String>) -> Self

Subscribes subscription to topic (a bare name, a tenant/namespace/topic triple, or a fully qualified name).

Source

pub fn topics<I, S>(topics: I, subscription: impl Into<String>) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Subscribes to every topic in the list.

Source

pub fn pattern( pattern: impl Into<String>, subscription: impl Into<String>, ) -> Self

Subscribes to every topic in the lookup namespace whose name matches pattern (a regular expression, validated on subscribe).

Source

pub fn subscription_type(self, sub_type: SubscriptionType) -> Self

Sets the subscription type. Defaults to SubscriptionType::Shared.

Source

pub fn dead_letter(self, dead_letter: DeadLetter) -> Self

Sets the consumer-side dead-letter policy.

Source

pub fn ack_timeout(self, timeout: Duration) -> Self

Redelivers messages that stay unacknowledged longer than timeout.

Source

pub fn subscription(&self) -> &str

The subscription name.

Trait Implementations§

Source§

impl Clone for PulsarSubscription

Source§

fn clone(&self) -> PulsarSubscription

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 PulsarSubscription

Source§

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

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

impl Eq for PulsarSubscription

Source§

impl PartialEq for PulsarSubscription

Source§

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

Source§

impl SubscriptionSource<ConnectedPulsarBroker> for PulsarSubscription

Source§

type Subscriber = PulsarSubscriber

The subscriber type this source opens.
Source§

fn name(&self) -> &str

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

async fn subscribe( self, connected: &ConnectedPulsarBroker, ) -> Result<PulsarSubscriber, PulsarError>

Opens the subscription against the connected broker. Called once at startup. 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<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> 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> 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 = 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<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