Struct pulsar::consumer::builder::ConsumerBuilder

pub struct ConsumerBuilder<Exe: Executor> { /* private fields */ }

Builder structure for consumers

This is the main way to create a Consumer or a Reader

Implementations

impl<Exe: Executor> ConsumerBuilder<Exe>

pub fn new(pulsar: &Pulsar<Exe>) -> Self

Creates a new ConsumerBuilder from an existing client instance

pub fn with_topic<S: Into<String>>(self, topic: S) -> ConsumerBuilder<Exe>

sets the consumer’s topic or add one to the list of topics

pub fn with_topics<S: AsRef<str>, I: IntoIterator<Item = S>>( self, topics: I ) -> ConsumerBuilder<Exe>

adds a list of topics to the future consumer

pub fn with_topic_regex(self, regex: Regex) -> ConsumerBuilder<Exe>

sets up a consumer that will listen on all topics matching the regular expression

pub fn with_subscription<S: Into<String>>(self, subscription: S) -> Self

sets the subscription’s name

pub fn with_subscription_type(self, subscription_type: SubType) -> Self

sets the kind of subscription

pub fn with_lookup_namespace<S: Into<String>>(self, namespace: S) -> Self

Tenant/Namespace to be used when matching against a regex. For other consumers, specify namespace using the <persistent|non-persistent://<tenant>/<namespace>/<topic> topic format. Defaults to public/default if not specifid

pub fn with_topic_refresh(self, refresh_interval: Duration) -> Self

Interval for refreshing the topics when using a topic regex. Unused otherwise.

pub fn with_consumer_id(self, consumer_id: u64) -> Self

sets the consumer id for this consumer

pub fn with_consumer_name<S: Into<String>>(self, consumer_name: S) -> Self

sets the consumer’s name

pub fn with_batch_size(self, batch_size: u32) -> Self

sets the batch size

batch messages containing more than the configured batch size will not be sent by Pulsar

default value: 1000

pub fn with_options(self, options: ConsumerOptions) -> Self

sets consumer options

pub fn with_dead_letter_policy( self, dead_letter_policy: DeadLetterPolicy ) -> Self

sets the dead letter policy

pub fn with_unacked_message_resend_delay(self, delay: Option<Duration>) -> Self

The time after which a message is dropped without being acknowledged or nacked that the message is resent. If None, messages will only be resent when a consumer disconnects with pending unacknowledged messages.

pub async fn build<T: DeserializeMessage>( self ) -> Result<Consumer<T, Exe>, Error>

creates a Consumer from this builder

pub async fn into_reader<T: DeserializeMessage>( self ) -> Result<Reader<T, Exe>, Error>

creates a Reader from this builder

Trait Implementations

impl<Exe: Clone + Executor> Clone for ConsumerBuilder<Exe>

fn clone(&self) -> ConsumerBuilder<Exe>

Returns a copy of the value.

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

Performs copy-assignment from source.