Struct NatsSourceConfig 

pub struct NatsSourceConfig {
    pub connection: NatsConnectionConfig,
    pub subject: String,
    pub queue_group: Option<String>,
    pub jetstream_stream: Option<String>,
    pub jetstream_consumer: Option<String>,
    pub max_messages: Option<usize>,
    pub idle_timeout_secs: Option<u64>,
    pub batch_size: usize,
}

Available on crate features source-nats and source-rest only.

Configuration for NatsSource.

The NatsConnectionConfig surface (servers / auth / tls / name) is flattened in, so a config looks like:

servers: ["nats://127.0.0.1:4222"]
subject: "events.>"
idle_timeout_secs: 5
batch_size: 500

Fields

connection: NatsConnectionConfig

Connection settings (servers, auth, tls, name).

subject: String

Subject to subscribe to. Supports NATS wildcards (* for one token, > for the remaining tokens). In JetStream mode the durable consumer’s own filter subject governs delivery and this field is informational.

queue_group: Option<String>

Optional queue group for core-NATS load-balanced subscriptions — all subscribers sharing a group split the subject’s messages. Ignored in JetStream mode.

jetstream_stream: Option<String>

JetStream stream name. When set together with jetstream_consumer the source pulls from a durable JetStream consumer instead of a core-NATS subscription.

jetstream_consumer: Option<String>

Name of the durable JetStream (pull) consumer to bind to. Required when jetstream_stream is set; the consumer must already exist on the server.

max_messages: Option<usize>

Stop after this many messages have been drained. At least one of max_messages / idle_timeout_secs must be set so a run terminates.

idle_timeout_secs: Option<u64>

Stop after this many seconds elapse with no new message. At least one of max_messages / idle_timeout_secs must be set so a run terminates.

batch_size: usize

Messages per emitted StreamPage. Drained messages accumulate in an in-memory buffer and a page is yielded when the buffer reaches this size (or when the run terminates with a partial buffer). Defaults to DEFAULT_BATCH_SIZE.

batch_size = 0 is the “drain-entire-run-window” sentinel: every message produced before the terminator fires goes into a single page.

Implementations

impl NatsSourceConfig

pub fn new(subject: impl Into<String>) -> NatsSourceConfig

Convenience constructor for a minimal core-NATS subscription with an idle-timeout terminator.

pub fn is_jetstream(&self) -> bool

Whether this config selects JetStream (pull-consumer) mode.

pub fn validate(&self) -> Result<(), FaucetError>

Validate the config at construction time.

Trait Implementations

impl Clone for NatsSourceConfig

fn clone(&self) -> NatsSourceConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NatsSourceConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NatsSourceConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for NatsSourceConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for NatsSourceConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.