Struct RouteOptions 

pub struct RouteOptions {
    pub description: String,
    pub concurrency: usize,
    pub batch_size: usize,
    pub commit_concurrency_limit: usize,
    pub startup_timeout_ms: u64,
    pub reconnect_interval_ms: u64,
    pub empty_batch_delay_ms: u64,
    pub allow_fault_injection: bool,
}

Fine-tuning options for a route’s execution.

These options control concurrency, batching, and commit behavior for message processing.

Examples

use mq_bridge::models::RouteOptions;

let options = RouteOptions {
    description: "My Route".to_string(),
    concurrency: 10,
    batch_size: 5,
    commit_concurrency_limit: 1024,
    ..Default::default()
};

Fields

description: String

A human-readable description of the route’s purpose. Defaults to an empty string.

concurrency: usize

(Optional) Number of concurrent processing tasks for this route. While it improves throughput for high-latency handlers, it adds synchronization overhead for ordered commits and may lead to out-of-order processing in the handler. Defaults to 1.

batch_size: usize

(Optional) Maximum number of messages to process in a single batch. The consumer waits for at least one message and then attempts to fetch more if available. Increasing this improves throughput but also increases the potential impact of a single batch processing failure. Defaults to 1.

commit_concurrency_limit: usize

(Optional) The maximum number of in-flight commit requests queued for ordered sequencing. Lower values apply backpressure earlier; higher values allow larger commit backlogs. Defaults to 4096.

startup_timeout_ms: u64

Time to wait for a route to establish connections before startup fails. Defaults to 5000ms.

reconnect_interval_ms: u64

Time to wait before reconnecting after a transient route failure. Defaults to 5000ms.

empty_batch_delay_ms: u64

Delay after an empty receive batch to avoid hot polling. Set to 0 to only yield. Defaults to 10ms.

allow_fault_injection: bool

Allows fault-injection middleware such as random_panic. Disabled by default.

Implementations

impl RouteOptions

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

Trait Implementations

impl Clone for RouteOptions

fn clone(&self) -> RouteOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RouteOptions

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

Formats the value using the given formatter.

impl Default for RouteOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RouteOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RouteOptions

impl PartialEq for RouteOptions

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for RouteOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RouteOptions