docs(multipart): doc PayloadBuffer::readline

robjtede · robjtede · commit 16125bd3be26 · 2024-07-07T20:19:56.000+01:00
diff --git a/actix-multipart/src/payload.rs b/actix-multipart/src/payload.rs
@@ -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]
     pub(crate) fn readline(&mut self) -> Result<Option<Bytes>, Error> {
         self.read_until(b"\n")

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