Fix documentation.

examples/list-all-transactions.rs

@@ -72,10 +72,15 @@ async fn main() -> anyhow::Result<()> {
     };
     // Query blocks by increasing height.
     let mut block_stream = client.get_finalized_blocks_from(h).await?;
-    while let Ok((timeout, chunk)) = block_stream
-        .next_chunk_timeout(app.num as usize, std::time::Duration::from_millis(500))
-        .await
-    {
+    loop {
+        let Ok((error, chunk)) = block_stream
+            .next_chunk_timeout(app.num as usize, std::time::Duration::from_millis(500))
+            .await
+        else {
+            // if we failed and end time is not yet here, then wait a bit
+            tokio::time::sleep(std::time::Duration::from_millis(500)).await;
+            continue;
+        };
         let mut handles = Vec::with_capacity(app.num as usize);
         for block in chunk {
             let mut cc = client.clone();
@@ -133,10 +138,8 @@ async fn main() -> anyhow::Result<()> {
                 }
             }
         }
-        if timeout {
-            // if we failed and end time is not yet here, then wait a bit
-            tokio::time::sleep(std::time::Duration::from_millis(500)).await;
+        if error {
+            anyhow::bail!("Finalized blocks vanished.")
         }
     }
-    Ok(())
 }

src/v2/mod.rs

@@ -2774,10 +2774,9 @@ impl FinalizedBlocksStream {
     /// occurred (it is `true` if an error occurred) while getting blocks.
     /// If that is the case further calls will always yield an error.
     ///
-    /// The first field of the response indicates if an error occurred, either
-    /// due to a timeout or the receiver channel was disconnected.
-    /// Concretely, if no blocks are available in time then `Ok((true,
-    /// Vec::new()))` is returned.
+    /// The first field of the response indicates if an error occurred. This
+    /// will only happen if the stream of finalized blocks has unexpectedly
+    /// dropped.
     pub async fn next_chunk_timeout(
         &mut self,
         n: usize,