docs(tvix): fix some docstrings
Change-Id: Ife599387d0472cd746b992bd6755a2fb6a0e0dc4 Reviewed-on: https://cl.tvl.fyi/c/depot/+/11158 Autosubmit: flokli <flokli@flokli.de> Reviewed-by: Connor Brewster <cbrewster@hey.com> Tested-by: BuildkiteCI
This commit is contained in:
parent
d3534ee051
commit
56dc4f735b
4 changed files with 5 additions and 5 deletions
|
|
@ -7,7 +7,7 @@ use super::primitive;
|
|||
#[allow(dead_code)]
|
||||
/// Read a limited number of bytes from the AsyncRead.
|
||||
/// Rejects reading more than `allowed_size` bytes of payload.
|
||||
/// Internally takes care of dealing with the padding, so the returned Vec<u8>
|
||||
/// Internally takes care of dealing with the padding, so the returned `Vec<u8>`
|
||||
/// only contains the payload.
|
||||
/// This always buffers the entire contents into memory, we'll add a streaming
|
||||
/// version later.
|
||||
|
|
@ -67,7 +67,7 @@ where
|
|||
/// Read an unlimited number of bytes from the AsyncRead.
|
||||
/// Note this can exhaust memory.
|
||||
/// Internally uses [read_bytes], which takes care of dealing with the padding,
|
||||
/// so the returned Vec<u8> only contains the payload.
|
||||
/// so the returned `Vec<u8>` only contains the payload.
|
||||
pub async fn read_bytes_unchecked<R: AsyncReadExt + Unpin>(r: &mut R) -> std::io::Result<Vec<u8>> {
|
||||
read_bytes(r, 0u64..).await
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue