Documenting and improving stream behaviour

git-svn-id: https://svn.kapsi.fi/jpa/nanopb@954 e3a754e5-d11d-0410-8d38-ebb782a927b9
This commit is contained in:
Petteri Aimonen
2011-08-11 19:22:36 +00:00
parent 09f92bafa5
commit 6dfba365b0
10 changed files with 193 additions and 21 deletions

View File

@@ -17,14 +17,14 @@
* max_size is not checked.
*
* Rules for callback:
* 1) Return false on IO errors. This will cause decoding to abort.
* 1) Return false on IO errors. This will cause encoding to abort.
*
* 2) You can use state to store your own data (e.g. buffer pointer).
*
* 3) pb_write will update bytes_written after your callback runs.
*
* 4) Your callback will be always used with the same pb_ostream_t.
* There are no substreams when encoding.
* 4) Substreams will modify max_size and bytes_written. Don't use them to
* calculate any pointers.
*/
struct _pb_ostream_t
{