mirrors/actix-web
1
0
Fork 0
mirror of https://github.com/actix/actix-web.git synced 2024-11-22 01:21:10 +00:00
Code Issues Projects Releases Wiki Activity

docs(multipart): doc PayloadBuffer::readline

Browse source
This commit is contained in:
Rob Ede 2024-07-07 20:19:56 +01:00
parent e9ccfbc866
commit 16125bd3be
No known key found for this signature in database
GPG key ID: 97C636207D3EF933
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
actix-multipart/src/payload.rs
View file

@ -122,7 +122,13 @@ impl PayloadBuffer {
} }
} }
/// Reads bytes until new line delimiter. /// Reads bytes until new line delimiter (`\n`, `0x0A`).
///
/// Returns:
///
/// - `Ok(Some(chunk))` - `needle` is found, with chunk ending after needle
/// - `Err(Incomplete)` - `needle` is not found and we're at EOF
/// - `Ok(None)` - `needle` is not found otherwise
#[inline] #[inline]
pub(crate) fn readline(&mut self) -> Result<Option<Bytes>, Error> { pub(crate) fn readline(&mut self) -> Result<Option<Bytes>, Error> {
self.read_until(b"\n") self.read_until(b"\n")