Struct async_nats::jetstream::consumer::pull::OrderedConfig

pub struct OrderedConfig {

    pub name: Option<String>,
    pub description: Option<String>,
    pub filter_subject: String,
    pub filter_subjects: Vec<String>,
    pub replay_policy: ReplayPolicy,
    pub rate_limit: u64,
    pub sample_frequency: u8,
    pub headers_only: bool,
    pub deliver_policy: DeliverPolicy,
    pub max_waiting: i64,
    pub metadata: HashMap<String, String>,
    pub max_batch: i64,
    pub max_bytes: i64,
    pub max_expires: Duration,
}

Configuration for consumers. From a high level, the durable_name and deliver_subject fields have a particularly strong influence on the consumer’s overall behavior.

Fields

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.

filter_subject: String

filter_subjects: Vec<String>

Available on crate feature server_2_10 only.

Fulfills the same role as Config::filter_subject, but allows filtering by many subjects.

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

headers_only: bool

Only deliver headers without payloads.

deliver_policy: DeliverPolicy

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

max_waiting: i64

The maximum number of waiting consumers.

metadata: HashMap<String, String>

Available on crate feature server_2_10 only.

max_batch: i64

max_bytes: i64

max_expires: Duration

Trait Implementations

impl Clone for OrderedConfig

fn clone(&self) -> OrderedConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OrderedConfig

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

Formats the value using the given formatter.

impl Default for OrderedConfig

fn default() -> OrderedConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OrderedConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<OrderedConfig> for Config

fn from(config: OrderedConfig) -> Self

Converts to this type from the input type.

impl FromConsumer for OrderedConfig

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

where Self: Sized,

impl IntoConsumerConfig for OrderedConfig

fn into_consumer_config(self) -> Config

impl PartialEq for OrderedConfig

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

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 OrderedConfig

impl StructuralEq for OrderedConfig

impl StructuralPartialEq for OrderedConfig