diff --git a/crates/fluvio-benchmark/src/benchmark_config/benchmark_matrix.rs b/crates/fluvio-benchmark/src/benchmark_config/benchmark_matrix.rs index 41189aa8fc..a93236634a 100644 --- a/crates/fluvio-benchmark/src/benchmark_config/benchmark_matrix.rs +++ b/crates/fluvio-benchmark/src/benchmark_config/benchmark_matrix.rs @@ -26,7 +26,7 @@ impl SharedConfig { } } -/// Corresponds to https://docs.rs/fluvio/latest/fluvio/struct.TopicProducerConfigBuilder.html +/// Corresponds to #[derive(Debug, Serialize, Deserialize, Clone)] pub struct FluvioProducerConfig { pub batch_size: Vec, @@ -54,7 +54,7 @@ impl Default for FluvioProducerConfig { } } -/// Corresponds to https://docs.rs/fluvio/latest/fluvio/consumer/struct.ConsumerConfigBuilder.html +/// Corresponds to #[derive(Debug, Serialize, Deserialize, Clone)] pub struct FluvioConsumerConfig { pub max_bytes: Vec, @@ -69,7 +69,7 @@ impl Default for FluvioConsumerConfig { } } -/// Corresponds to https://docs.rs/fluvio/latest/fluvio/metadata/topic/struct.TopicSpec.html +/// Corresponds to #[derive(Debug, Serialize, Deserialize, Clone)] pub struct FluvioTopicConfig { pub num_partitions: Vec, diff --git a/crates/fluvio-test-util/test_meta/environment.rs b/crates/fluvio-test-util/test_meta/environment.rs index c6e4554339..21bdc55475 100644 --- a/crates/fluvio-test-util/test_meta/environment.rs +++ b/crates/fluvio-test-util/test_meta/environment.rs @@ -162,7 +162,7 @@ pub struct EnvironmentSetup { #[arg(long, default_value = "1")] pub topic: u16, - /// Append random as "-" to topic name (before id, if --num-topics > 1) + /// Append random as "-\" to topic name (before id, if --num-topics > 1) #[arg(long)] pub topic_random: bool, diff --git a/crates/fluvio/src/producer/mod.rs b/crates/fluvio/src/producer/mod.rs index 90f22679e6..de597693f2 100644 --- a/crates/fluvio/src/producer/mod.rs +++ b/crates/fluvio/src/producer/mod.rs @@ -1,3 +1,11 @@ +//! The Fluvio Producer module allows applications to send messages to topics in the Fluvio cluster. +//! +//! # Overview +//! +//! This module provides the necessary structures and functions to produce messages to a Fluvio topic. +//! It includes the `TopicProducerPool` struct, which manages the production of messages +//! to specific topics and partitions, respectively. +//! use std::collections::HashMap; use std::sync::Arc; @@ -47,6 +55,7 @@ pub use self::output::ProduceOutput; use self::partition_producer::PartitionProducer; pub use self::record::{FutureRecordMetadata, RecordMetadata}; +/// Pool of producers for a given topic. There is a producer per partition pub type TopicProducerPool = TopicProducer; /// Pool of producers for a given topic. There is a producer per partition