Struct nats::jetstream::SubscribeOptions

pub struct SubscribeOptions { /* private fields */ }

Options for subscription

Implementations

impl SubscribeOptions

pub fn new() -> Self

Creates a new set of default subscription options

pub fn bind(stream_name: String, consumer_name: String) -> Self

Binds to an existing consumer from a stream without attempting to create one.

pub fn ordered() -> Self

Creates an ordered fifo (first-in-first-out) subscription.

pub fn bind_stream(stream_name: String) -> Self

Binds the consumer to a stream explicitly based on a name.

When a stream name is not specified, the subject is used as a way to find the stream name. This is done by making a request to the server to get list of stream names that have a filter the subject. To avoid the stream lookup, provide the stream name with this function.

pub fn description(self, description: String) -> Self

Sets the description used for the created consumer.

pub fn durable_name(self, consumer: String) -> Self

Sets the durable name for the created consumer.

pub fn deliver_all(self) -> Self

Configures the consumer to receive all the messages from a Stream.

pub fn deliver_last(self) -> Self

Configures the consumer to receive messages starting with the latest one.

pub fn deliver_last_per_subject(self) -> Self

Configures the consumer to receive messages starting with the latest one for each filtered subject.

pub fn deliver_new(self) -> Self

Configures the consumer to receive messages published after the subscription.

pub fn deliver_by_start_sequence(self, seq: u64) -> Self

Configures a Consumer to receive messages from a start sequence.

pub fn deliver_by_start_time(self, time: DateTime) -> Self

Configures the consumer to receive messages from a start time.

pub fn ack_none(self) -> Self

Require no acks for delivered messages.

pub fn ack_all(self) -> Self

When acking a sequence number, this implicitly acks all sequences below this one as well.

pub fn ack_explicit(self) -> Self

Requires ack or nack for all messages.

pub fn max_deliver(self, n: i64) -> Self

Sets the number of redeliveries for a message.

pub fn max_ack_pending(self, n: i64) -> Self

Sets the number of outstanding acks that are allowed before message delivery is halted.

pub fn replay_original(self) -> Self

Replays the messages at the original speed.

pub fn replay_instant(self) -> Self

Replays the messages as fast as possible.

pub fn rate_limit(self, n: u64) -> Self

The bits per second rate limit applied to the push consumer.

pub fn deliver_subject(self, subject: String) -> Self

Specifies the consumer deliver subject.

This option is used only in situations where the consumer does not exist and a creation request is sent to the server.

If not provided, an inbox will be selected.

pub fn headers_only(self) -> Self

Instruct the consumer to only deliver headers and no payloads.

pub fn enable_flow_control(self) -> Self

Enables flow control

pub fn idle_heartbeat(self, interval: Duration) -> Self

Enables hearbeat messages to be sent.

Trait Implementations

impl Clone for SubscribeOptions

fn clone(&self) -> SubscribeOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SubscribeOptions

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

Formats the value using the given formatter.

impl Default for SubscribeOptions

fn default() -> SubscribeOptions

Returns the “default value” for a type.