Skip to content

Commit

Permalink
Add documentation for SyncIoBridge with examples and alternatives
Browse files Browse the repository at this point in the history
  • Loading branch information
Nathy-bajo committed Sep 3, 2024
1 parent 3008e7b commit 30d38d5
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion tokio-util/src/io/sync_bridge.rs
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ use tokio::io::{
/// tokio::io::copy(&mut reader, &mut encoder).await?;
/// ```
///
/// ## Example 3: Parsing JSON
/// ## Example 3: Parsing `JSON`
///
/// When parsing `JSON` data, avoid using `SyncIoBridge` with `serde_json::from_reader` as it may cause blocking operations.
/// Instead, read the data into a `Vec<u8>` and parse it using `serde_json::from_slice`.
Expand Down

0 comments on commit 30d38d5

Please sign in to comment.