about summary refs log tree commit diff
diff options
context:
space:
mode:
authorFlorian Klink <flokli@flokli.de>2024-04-24T16·14+0300
committerclbot <clbot@tvl.fyi>2024-04-24T20·06+0000
commit2fd9dc11c2bbdc826a4fb84d2d149b5b1cce7746 (patch)
tree8682f1267a395276ffb8fb3816ac469d68c7f1a3
parentd2e67f021ecb54435d5ac57aa431364417eb59fa (diff)
docs(tvix/nix-compat): add missing reference to BytesReader r/8003
Change-Id: Ideed83d191b55e131720e598b7591e8375a26cfd
Reviewed-on: https://cl.tvl.fyi/c/depot/+/11510
Tested-by: BuildkiteCI
Reviewed-by: edef <edef@edef.eu>
Autosubmit: flokli <flokli@flokli.de>
-rw-r--r--tvix/nix-compat/src/wire/bytes/mod.rs4
1 files changed, 2 insertions, 2 deletions
diff --git a/tvix/nix-compat/src/wire/bytes/mod.rs b/tvix/nix-compat/src/wire/bytes/mod.rs
index 9487536eb7..9ec8b3fa04 100644
--- a/tvix/nix-compat/src/wire/bytes/mod.rs
+++ b/tvix/nix-compat/src/wire/bytes/mod.rs
@@ -33,8 +33,8 @@ const LEN_SIZE: usize = 8;
 /// On failure (for example if a too large byte packet was sent), the reader
 /// becomes unusable.
 ///
-/// This buffers the entire payload into memory, a streaming version will be
-/// added later.
+/// This buffers the entire payload into memory,
+/// a streaming version is available at [crate::wire::bytes::BytesReader].
 pub async fn read_bytes<R, S>(r: &mut R, allowed_size: S) -> std::io::Result<Vec<u8>>
 where
     R: AsyncReadExt + Unpin,