Skip to main content

KafkaSourceConfig

Struct KafkaSourceConfig 

Source
pub struct KafkaSourceConfig {
Show 22 fields pub bootstrap_servers: Vec<String>, pub group_id: String, pub topics: Vec<String>, pub auto_offset_reset: String, pub enable_auto_commit: bool, pub auto_commit_interval: Duration, pub max_poll_records: usize, pub fetch_wait_max: Duration, pub fetch_min_bytes: usize, pub max_partition_fetch_bytes: usize, pub session_timeout: Duration, pub heartbeat_interval: Duration, pub security_protocol: SecurityProtocol, pub sasl_mechanism: Option<SaslMechanism>, pub sasl_username: Option<String>, pub sasl_password: Option<String>, pub ssl_config: Option<SslConfig>, pub num_consumer_threads: usize, pub queued_max_messages: usize, pub socket_receive_buffer_bytes: usize, pub isolation_level: String, pub additional_properties: HashMap<String, String>,
}
Expand description

Kafka source (consumer) configuration.

This structure provides all necessary settings for consuming from Kafka topics, including consumer group management, offset handling, and performance tuning.

§Examples

use processor::kafka::config::{KafkaSourceConfig, SecurityProtocol};
use std::time::Duration;

let config = KafkaSourceConfig::builder()
    .bootstrap_servers(vec!["localhost:9092".to_string()])
    .group_id("my-consumer-group".to_string())
    .topics(vec!["events".to_string(), "metrics".to_string()])
    .auto_offset_reset("earliest".to_string())
    .enable_auto_commit(false)
    .max_poll_records(500)
    .session_timeout(Duration::from_secs(30))
    .build()
    .expect("valid configuration");

assert!(config.validate().is_ok());

Fields§

§bootstrap_servers: Vec<String>

Kafka broker addresses (host:port).

§group_id: String

Consumer group ID for coordinated consumption.

§topics: Vec<String>

Topics to subscribe to.

§auto_offset_reset: String

What to do when there is no initial offset: “earliest”, “latest”, “none”.

§enable_auto_commit: bool

Enable automatic offset commits.

§auto_commit_interval: Duration

Frequency of auto-commits if enabled.

§max_poll_records: usize

Maximum number of records to poll in a single batch.

§fetch_wait_max: Duration

Maximum time to wait for poll batch to fill.

§fetch_min_bytes: usize

Minimum bytes to fetch per request.

§max_partition_fetch_bytes: usize

Maximum bytes to fetch per partition.

§session_timeout: Duration

Session timeout for consumer group membership.

§heartbeat_interval: Duration

Heartbeat interval to coordinator.

§security_protocol: SecurityProtocol

Security protocol to use.

§sasl_mechanism: Option<SaslMechanism>

SASL mechanism if using SASL authentication.

§sasl_username: Option<String>

SASL username.

§sasl_password: Option<String>

SASL password.

§ssl_config: Option<SslConfig>

SSL configuration.

§num_consumer_threads: usize

Number of consumer threads for parallel consumption.

§queued_max_messages: usize

Size of the internal queue for buffering messages.

§socket_receive_buffer_bytes: usize

Socket receive buffer size.

§isolation_level: String

Transaction isolation level: “read_uncommitted” or “read_committed”.

§additional_properties: HashMap<String, String>

Additional rdkafka configuration properties.

Implementations§

Source§

impl KafkaSourceConfig

Source

pub fn builder() -> KafkaSourceConfigBuilder

Create a new builder for KafkaSourceConfig.

Source

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

Validate the configuration.

§Errors

Returns an error if:

  • Bootstrap servers are empty
  • Group ID is empty
  • Topics are empty
  • Invalid auto_offset_reset value
  • Invalid isolation_level value
  • SASL credentials missing when SASL is enabled
Source

pub fn to_rdkafka_properties(&self) -> HashMap<String, String>

Convert to rdkafka ClientConfig properties.

Trait Implementations§

Source§

impl Clone for KafkaSourceConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KafkaSourceConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for KafkaSourceConfig

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for KafkaSourceConfig

Source§

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

Serialize this value into the given Serde serializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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 = !

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

fn try_from(value: U) -> Result<T, !>

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