diff options
author | Petteri Aimonen <jpa@git.mail.kapsi.fi> | 2012-10-18 19:45:28 +0300 |
---|---|---|
committer | Petteri Aimonen <jpa@git.mail.kapsi.fi> | 2012-10-18 19:45:28 +0300 |
commit | dcab39a41c0a403db38860c22426075e6ae9f25d (patch) | |
tree | 7f1824628371ec59353b0765a209e6e5518401f7 /docs | |
parent | 900c8dd1252afe2b2474b852ae48dcb46e100505 (diff) |
Remove the "buf = NULL" => skip requirement from pb_istream_t callbacks.
Rationale: it's easy to implement the callback wrong. Doing so introduces
io errors when unknown fields are present in the input. If code is not
tested with unknown fields, these bugs can remain hidden for long time.
Added a special case for the memory buffer stream, where it gives a small
speed benefit.
Added testcase for skipping fields with test_decode2 implementation.
Update issue 37
Status: FixedInGit
Diffstat (limited to 'docs')
-rw-r--r-- | docs/concepts.rst | 3 |
1 files changed, 1 insertions, 2 deletions
diff --git a/docs/concepts.rst b/docs/concepts.rst index d3261146..355af25e 100644 --- a/docs/concepts.rst +++ b/docs/concepts.rst @@ -92,9 +92,8 @@ Writing to stdout:: Input streams ------------- -For input streams, there are a few extra rules: +For input streams, there is one extra rule: -#) If buf is NULL, read from stream but don't store the data. This is used to skip unknown input. #) You don't need to know the length of the message in advance. After getting EOF error when reading, set bytes_left to 0 and return false. Pb_decode will detect this and if the EOF was in a proper position, it will return true. Here is the structure:: |