Skip to content

docs: add example for decode_length_delimiter #1311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: add example for decode_length_delimiter #1311

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
910a778
Add example for decode_length_delimiter.
armandas Aug 11, 2025
e7492a2
Simplify the example further.
armandas Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions prost/src/encoding/length_delimiter.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,18 @@ pub fn length_delimiter_len(length: usize) -> usize {
/// input is required to decode the full delimiter.
/// * If the supplied buffer contains 10 bytes or more, then the buffer contains an invalid
/// delimiter, and typically the buffer should be considered corrupt.
///
/// # Examples
///
/// ```
/// use prost::bytes::Bytes;
///
/// let mut buf = Bytes::from(vec![0x04, 0x0a, 0x02, 0x01, 0x02]);
/// let len = prost::decode_length_delimiter(&mut buf).unwrap();
///
/// assert_eq!(len, 4);
/// assert_eq!(&buf[..], [0x0a, 0x02, 0x01, 0x02]);
/// ```
pub fn decode_length_delimiter(mut buf: impl Buf) -> Result<usize, DecodeError> {
let length = decode_varint(&mut buf)?;
if length > usize::MAX as u64 {
Expand Down
Loading