Skip to main content

ConsumerConfig

Struct ConsumerConfig 

Source
pub struct ConsumerConfig {
Show 16 fields pub bootstrap_servers: Vec<String>, pub group_id: String, pub topics: Vec<String>, pub partitions: HashMap<String, Vec<u32>>, pub max_poll_records: u32, pub max_poll_interval_ms: u64, pub auto_commit_interval: Option<Duration>, pub isolation_level: u8, pub auth: Option<ConsumerAuthConfig>, pub metadata_refresh_interval: Duration, pub reconnect_backoff_ms: u64, pub reconnect_backoff_max_ms: u64, pub max_reconnect_attempts: u32, pub session_timeout_ms: u32, pub rebalance_timeout_ms: u32, pub heartbeat_interval_ms: u64,
}
Expand description

Configuration for the high-level consumer.

Fields§

§bootstrap_servers: Vec<String>

Bootstrap server addresses (host:port).

On initial connect and reconnect, the consumer tries each server in round-robin order until one succeeds. Accepts a single server or multiple for failover.

§group_id: String

Consumer group ID for offset management

§topics: Vec<String>

Topics to subscribe to

§partitions: HashMap<String, Vec<u32>>

Explicit partition assignments (topic → partitions). If empty, all partitions of each subscribed topic are consumed.

§max_poll_records: u32

Maximum messages per partition per poll

§max_poll_interval_ms: u64

Long-poll wait time in milliseconds (0 = immediate return)

§auto_commit_interval: Option<Duration>

Auto-commit interval (None = manual commit only)

§isolation_level: u8

Transaction isolation level (0 = read_uncommitted, 1 = read_committed)

§auth: Option<ConsumerAuthConfig>

Authentication credentials (optional)

§metadata_refresh_interval: Duration

Interval for re-discovering partition assignments (default: 5 min). Set to Duration::MAX to disable periodic re-discovery.

§reconnect_backoff_ms: u64

Initial reconnect backoff delay in milliseconds (default: 100)

§reconnect_backoff_max_ms: u64

Maximum reconnect backoff delay in milliseconds (default: 10 000)

§max_reconnect_attempts: u32

Maximum number of reconnect attempts before giving up (default: 10)

§session_timeout_ms: u32

Session timeout for group coordination in milliseconds (default: 10 000). If the coordinator does not receive a heartbeat within this interval, it considers the member dead and triggers a rebalance.

§rebalance_timeout_ms: u32

Rebalance timeout in milliseconds (default: 30 000). Maximum time the coordinator waits for all members to join during a rebalance.

§heartbeat_interval_ms: u64

Heartbeat interval in milliseconds (default: 3 000). Should be no more than 1/3 of session_timeout_ms.

Implementations§

Trait Implementations§

Source§

impl Clone for ConsumerConfig

Source§

fn clone(&self) -> ConsumerConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConsumerConfig

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more