Struct async_nats::jetstream::consumer::pull::Config

pub struct Config {

    pub durable_name: Option<String>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub deliver_policy: DeliverPolicy,
    pub ack_policy: AckPolicy,
    pub ack_wait: Duration,
    pub max_deliver: i64,
    pub filter_subject: String,
    pub replay_policy: ReplayPolicy,
    pub rate_limit: u64,
    pub sample_frequency: u8,
    pub max_waiting: i64,
    pub max_ack_pending: i64,
    pub headers_only: bool,
    pub max_batch: i64,
    pub max_expires: Duration,
    pub inactive_threshold: Duration,
    pub num_replicas: usize,
    pub memory_storage: bool,
}

Fields

durable_name: Option<String>

Setting durable_name to Some(...) will cause this consumer to be “durable”. This may be a good choice for workloads that benefit from the JetStream server or cluster remembering the progress of consumers for fault tolerance purposes. If a consumer crashes, the JetStream server or cluster will remember which messages the consumer acknowledged. When the consumer recovers, this information will allow the consumer to resume processing where it left off. If you’re unsure, set this to Some(...).

Setting durable_name to None will cause this consumer to be “ephemeral”. This may be a good choice for workloads where you don’t need the JetStream server to remember the consumer’s progress in the case of a crash, such as certain “high churn” workloads or workloads where a crashed instance is not required to recover.

name: Option<String>

A name of the consumer. Can be specified for both durable and ephemeral consumers.

description: Option<String>

A short description of the purpose of this consumer.

deliver_policy: DeliverPolicy

Allows for a variety of options that determine how this consumer will receive messages

ack_policy: AckPolicy

How messages should be acknowledged

ack_wait: Duration

How long to allow messages to remain un-acknowledged before attempting redelivery

max_deliver: i64

Maximum number of times a specific message will be delivered. Use this to avoid poison pill messages that repeatedly crash your consumer processes forever.

filter_subject: String

When consuming from a Stream with many subjects, or wildcards, this selects only specific incoming subjects. Supports wildcards.

replay_policy: ReplayPolicy

Whether messages are sent as quickly as possible or at the rate of receipt

rate_limit: u64

The rate of message delivery in bits per second

sample_frequency: u8

What percentage of acknowledgments should be samples for observability, 0-100

max_waiting: i64

The maximum number of waiting consumers.

max_ack_pending: i64

The maximum number of unacknowledged messages that may be in-flight before pausing sending additional messages to this consumer.

headers_only: bool

Only deliver headers without payloads.

max_batch: i64

Maximum size of a request batch

max_expires: Duration

Maximum value for request expiration

inactive_threshold: Duration

Threshold for ephemeral consumer inactivity

num_replicas: usize

Number of consumer replicas

memory_storage: bool

Force consumer to use memory storage.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromConsumer for Config

fn try_from_consumer_config(config: Config) -> Result<Self, Error>

impl IntoConsumerConfig for &Config

fn into_consumer_config(self) -> Config

impl IntoConsumerConfig for Config

fn into_consumer_config(self) -> Config

impl PartialEq<Config> for Config

fn eq(&self, other: &Config) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Config

impl StructuralEq for Config

impl StructuralPartialEq for Config