Improve print in case if consumer is not initialized (#1394)

sdk/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "iggy"
-version = "0.6.60"
+version = "0.6.61"
 description = "Iggy is the persistent message streaming platform written in Rust, supporting QUIC, TCP and HTTP transport protocols, capable of processing millions of messages per second."
 edition = "2021"
 license = "MIT"

sdk/src/clients/consumer.rs

@@ -206,6 +206,8 @@ impl IggyConsumer {
     }
 
     /// Initializes the consumer by subscribing to diagnostic events, initializing the consumer group if needed, storing the offsets in the background etc.
+    ///
+    /// Note: This method must be called before polling messages.
     pub async fn init(&mut self) -> Result<(), IggyError> {
         if self.initialized {
             return Ok(());
@@ -338,7 +340,7 @@ impl IggyConsumer {
 
     fn send_store_offset(&self, partition_id: u32, offset: u64) {
         if let Err(error) = self.store_offset_sender.send((partition_id, offset)) {
-            error!("Failed to send offset to store: {error}");
+            error!("Failed to send offset to store: {error}, please verify if `init()` on IggyConsumer object has been called.");
         }
     }
 
@@ -985,6 +987,9 @@ impl IggyConsumerBuilder {
         }
     }
 
+    /// Builds the consumer.
+    ///
+    /// Note: After building the consumer, `init()` must be invoked before producing messages.
     pub fn build(self) -> IggyConsumer {
         IggyConsumer::new(
             self.client,

sdk/src/clients/producer.rs

@@ -106,6 +106,8 @@ impl IggyProducer {
     }
 
     /// Initializes the producer by subscribing to diagnostic events, creating the stream and topic if they do not exist etc.
+    ///
+    /// Note: This method must be invoked before producing messages.
     pub async fn init(&mut self) -> Result<(), IggyError> {
         if self.initialized {
             return Ok(());
@@ -609,6 +611,9 @@ impl IggyProducerBuilder {
         }
     }
 
+    /// Builds the producer.
+    ///
+    /// Note: After building the producer, `init()` must be invoked before producing messages.
     pub fn build(self) -> IggyProducer {
         IggyProducer::new(
             self.client,