14 The following options can be specified in one of two ways:
16 1. Using the -D switch on the C compiler command line.
17 2. By #defining them at the top of pb.h.
19 You must have the same settings for the nanopb library and all code that
22 ============================ ================================================
23 PB_NO_PACKED_STRUCTS Disable packed structs. Increases RAM usage but
24 is necessary on some platforms that do not
25 support unaligned memory access.
26 PB_ENABLE_MALLOC Set this to enable dynamic allocation support
28 PB_MAX_REQUIRED_FIELDS Maximum number of required fields to check for
29 presence. Default value is 64. Increases stack
30 usage 1 byte per every 8 fields. Compiler
31 warning will tell if you need this.
32 PB_FIELD_16BIT Add support for tag numbers > 255 and fields
33 larger than 255 bytes or 255 array entries.
34 Increases code size 3 bytes per each field.
35 Compiler error will tell if you need this.
36 PB_FIELD_32BIT Add support for tag numbers > 65535 and fields
37 larger than 65535 bytes or 65535 array entries.
38 Increases code size 9 bytes per each field.
39 Compiler error will tell if you need this.
40 PB_NO_ERRMSG Disables the support for error messages; only
41 error information is the true/false return
42 value. Decreases the code size by a few hundred
44 PB_BUFFER_ONLY Disables the support for custom streams. Only
45 supports encoding and decoding with memory
46 buffers. Speeds up execution and decreases code
48 PB_OLD_CALLBACK_STYLE Use the old function signature (void\* instead
49 of void\*\*) for callback fields. This was the
50 default until nanopb-0.2.1.
51 PB_SYSTEM_HEADER Replace the standard header files with a single
52 header file. It should define all the required
53 functions and typedefs listed on the
54 `overview page`_. Value must include quotes,
55 for example *#define PB_SYSTEM_HEADER "foo.h"*.
56 ============================ ================================================
58 The PB_MAX_REQUIRED_FIELDS, PB_FIELD_16BIT and PB_FIELD_32BIT settings allow
59 raising some datatype limits to suit larger messages. Their need is recognized
60 automatically by C-preprocessor #if-directives in the generated .pb.h files.
61 The default setting is to use the smallest datatypes (least resources used).
63 .. _`overview page`: index.html#compiler-requirements
68 The generator behaviour can be adjusted using these options, defined in the
69 'nanopb.proto' file in the generator folder:
71 ============================ ================================================
72 max_size Allocated size for *bytes* and *string* fields.
73 max_count Allocated number of entries in arrays
75 int_size Override the integer type of a field.
76 (To use e.g. uint8_t to save RAM.)
77 type Type of the generated field. Default value
78 is *FT_DEFAULT*, which selects automatically.
79 You can use *FT_CALLBACK*, *FT_POINTER*,
80 *FT_STATIC*, *FT_IGNORE*, or *FT_INLINE* to
81 force a callback field, a dynamically
82 allocated field, a static field, to
83 completely ignore the field or to
84 generate an inline bytes field.
85 long_names Prefix the enum name to the enum value in
86 definitions, i.e. *EnumName_EnumValue*. Enabled
88 packed_struct Make the generated structures packed.
89 NOTE: This cannot be used on CPUs that break
90 on unaligned accesses to variables.
91 skip_message Skip the whole message from generation.
92 no_unions Generate 'oneof' fields as optional fields
94 msgid Specifies a unique id for this message type.
95 Can be used by user code as an identifier.
96 anonymous_oneof Generate 'oneof' fields as anonymous unions.
97 ============================ ================================================
99 These options can be defined for the .proto files before they are converted
100 using the nanopb-generatory.py. There are three ways to define the options:
102 1. Using a separate .options file.
103 This is the preferred way as of nanopb-0.2.1, because it has the best
104 compatibility with other protobuf libraries.
105 2. Defining the options on the command line of nanopb_generator.py.
106 This only makes sense for settings that apply to a whole file.
107 3. Defining the options in the .proto file using the nanopb extensions.
108 This is the way used in nanopb-0.1, and will remain supported in the
109 future. It however sometimes causes trouble when using the .proto file
110 with other protobuf libraries.
112 The effect of the options is the same no matter how they are given. The most
113 common purpose is to define maximum size for string fields in order to
114 statically allocate them.
116 Defining the options in a .options file
117 ---------------------------------------
118 The preferred way to define options is to have a separate file
119 'myproto.options' in the same directory as the 'myproto.proto'. ::
123 required string name = 1;
124 repeated int32 ids = 4;
130 MyMessage.name max_size:40
131 MyMessage.ids max_count:5
133 The generator will automatically search for this file and read the
134 options from it. The file format is as follows:
136 * Lines starting with '#' or '//' are regarded as comments.
137 * Blank lines are ignored.
138 * All other lines should start with a field name pattern, followed by one or
139 more options. For example: *"MyMessage.myfield max_size:5 max_count:10"*.
140 * The field name pattern is matched against a string of form *'Message.field'*.
141 For nested messages, the string is *'Message.SubMessage.field'*.
142 * The field name pattern may use the notation recognized by Python fnmatch():
144 - *\** matches any part of string, like 'Message.\*' for all fields
145 - *\?* matches any single character
146 - *[seq]* matches any of characters 's', 'e' and 'q'
147 - *[!seq]* matches any other character
149 * The options are written as *'option_name:option_value'* and several options
150 can be defined on same line, separated by whitespace.
151 * Options defined later in the file override the ones specified earlier, so
152 it makes sense to define wildcard options first in the file and more specific
155 If preferred, the name of the options file can be set using the command line
156 switch *-f* to nanopb_generator.py.
158 Defining the options on command line
159 ------------------------------------
160 The nanopb_generator.py has a simple command line option *-s OPTION:VALUE*.
161 The setting applies to the whole file that is being processed.
163 Defining the options in the .proto file
164 ---------------------------------------
165 The .proto file format allows defining custom options for the fields.
166 The nanopb library comes with *nanopb.proto* which does exactly that, allowing
167 you do define the options directly in the .proto file::
169 import "nanopb.proto";
172 required string name = 1 [(nanopb).max_size = 40];
173 repeated int32 ids = 4 [(nanopb).max_count = 5];
176 A small complication is that you have to set the include path of protoc so that
177 nanopb.proto can be found. This file, in turn, requires the file
178 *google/protobuf/descriptor.proto*. This is usually installed under
179 */usr/include*. Therefore, to compile a .proto file which uses options, use a
180 protoc command similar to::
182 protoc -I/usr/include -Inanopb/generator -I. -omessage.pb message.proto
184 The options can be defined in file, message and field scopes::
186 option (nanopb_fileopt).max_size = 20; // File scope
189 option (nanopb_msgopt).max_size = 30; // Message scope
190 required string fieldsize = 1 [(nanopb).max_size = 40]; // Field scope
206 Type used for storing byte-sized data, such as raw binary input and bytes-type fields. ::
208 typedef uint_least8_t pb_byte_t;
210 For most platforms this is equivalent to `uint8_t`. Some platforms however do not support
211 8-bit variables, and on those platforms 16 or 32 bits need to be used for each byte.
215 Type used to store the type of each field, to control the encoder/decoder behaviour. ::
217 typedef uint_least8_t pb_type_t;
219 The low-order nibble of the enumeration values defines the function that can be used for encoding and decoding the field data:
221 =========================== ===== ================================================
222 LTYPE identifier Value Storage format
223 =========================== ===== ================================================
224 PB_LTYPE_VARINT 0x00 Integer.
225 PB_LTYPE_UVARINT 0x01 Unsigned integer.
226 PB_LTYPE_SVARINT 0x02 Integer, zigzag encoded.
227 PB_LTYPE_FIXED32 0x03 32-bit integer or floating point.
228 PB_LTYPE_FIXED64 0x04 64-bit integer or floating point.
229 PB_LTYPE_BYTES 0x05 Structure with *size_t* field and byte array.
230 PB_LTYPE_STRING 0x06 Null-terminated string.
231 PB_LTYPE_SUBMESSAGE 0x07 Submessage structure.
232 PB_LTYPE_EXTENSION 0x08 Point to *pb_extension_t*.
233 PB_LTYPE_FIXED_LENGTH_BYTES 0x09 Inline *pb_byte_t* array of fixed size.
234 =========================== ===== ================================================
236 The bits 4-5 define whether the field is required, optional or repeated:
238 ==================== ===== ================================================
239 HTYPE identifier Value Field handling
240 ==================== ===== ================================================
241 PB_HTYPE_REQUIRED 0x00 Verify that field exists in decoded message.
242 PB_HTYPE_OPTIONAL 0x10 Use separate *has_<field>* boolean to specify
243 whether the field is present.
244 (Unless it is a callback)
245 PB_HTYPE_REPEATED 0x20 A repeated field with preallocated array.
246 Separate *<field>_count* for number of items.
247 (Unless it is a callback)
248 ==================== ===== ================================================
250 The bits 6-7 define the how the storage for the field is allocated:
252 ==================== ===== ================================================
253 ATYPE identifier Value Allocation method
254 ==================== ===== ================================================
255 PB_ATYPE_STATIC 0x00 Statically allocated storage in the structure.
256 PB_ATYPE_CALLBACK 0x40 A field with dynamic storage size. Struct field
257 actually contains a pointer to a callback
259 ==================== ===== ================================================
264 Describes a single structure field with memory position in relation to others. The descriptions are usually autogenerated. ::
266 typedef struct pb_field_s pb_field_t;
270 pb_size_t data_offset;
271 pb_ssize_t size_offset;
273 pb_size_t array_size;
277 :tag: Tag number of the field or 0 to terminate a list of fields.
278 :type: LTYPE, HTYPE and ATYPE of the field.
279 :data_offset: Offset of field data, relative to the end of the previous field.
280 :size_offset: Offset of *bool* flag for optional fields or *size_t* count for arrays, relative to field data.
281 :data_size: Size of a single data entry, in bytes. For PB_LTYPE_BYTES, the size of the byte array inside the containing structure. For PB_HTYPE_CALLBACK, size of the C data type if known.
282 :array_size: Maximum number of entries in an array, if it is an array type.
283 :ptr: Pointer to default value for optional fields, or to submessage description for PB_LTYPE_SUBMESSAGE.
285 The *uint8_t* datatypes limit the maximum size of a single item to 255 bytes and arrays to 255 items. Compiler will give error if the values are too large. The types can be changed to larger ones by defining *PB_FIELD_16BIT*.
289 An byte array with a field for storing the length::
296 In an actual array, the length of *bytes* may be different.
300 Part of a message structure, for fields with type PB_HTYPE_CALLBACK::
302 typedef struct _pb_callback_t pb_callback_t;
303 struct _pb_callback_t {
305 bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void **arg);
306 bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, void * const *arg);
312 A pointer to the *arg* is passed to the callback when calling. It can be used to store any information that the callback might need.
314 Previously the function received just the value of *arg* instead of a pointer to it. This old behaviour can be enabled by defining *PB_OLD_CALLBACK_STYLE*.
316 When calling `pb_encode`_, *funcs.encode* is used, and similarly when calling `pb_decode`_, *funcs.decode* is used. The function pointers are stored in the same memory location but are of incompatible types. You can set the function pointer to NULL to skip the field.
320 Protocol Buffers wire types. These are used with `pb_encode_tag`_. ::
331 Defines the handler functions and auxiliary data for a field that extends
332 another message. Usually autogenerated by *nanopb_generator.py*::
335 bool (*decode)(pb_istream_t *stream, pb_extension_t *extension,
336 uint32_t tag, pb_wire_type_t wire_type);
337 bool (*encode)(pb_ostream_t *stream, const pb_extension_t *extension);
339 } pb_extension_type_t;
341 In the normal case, the function pointers are *NULL* and the decoder and
342 encoder use their internal implementations. The internal implementations
343 assume that *arg* points to a *pb_field_t* that describes the field in question.
345 To implement custom processing of unknown fields, you can provide pointers
346 to your own functions. Their functionality is mostly the same as for normal
347 callback fields, except that they get called for any unknown field when decoding.
351 Ties together the extension field type and the storage for the field value::
354 const pb_extension_type_t *type;
356 pb_extension_t *next;
360 :type: Pointer to the structure that defines the callback functions.
361 :dest: Pointer to the variable that stores the field value
362 (as used by the default extension callback functions.)
363 :next: Pointer to the next extension handler, or *NULL*.
364 :found: Decoder sets this to true if the extension was found.
368 Get the current error message from a stream, or a placeholder string if
369 there is no error message::
371 #define PB_GET_ERROR(stream) (string expression)
373 This should be used for printing errors, for example::
377 printf("Decode failed: %s\n", PB_GET_ERROR(stream));
380 The macro only returns pointers to constant strings (in code memory),
381 so that there is no need to release the returned pointer.
385 Set the error message and return false::
387 #define PB_RETURN_ERROR(stream,msg) (sets error and returns false)
389 This should be used to handle error conditions inside nanopb functions
390 and user callback functions::
394 PB_RETURN_ERROR(stream, "something went wrong");
397 The *msg* parameter must be a constant string.
404 pb_ostream_from_buffer
405 ----------------------
406 Constructs an output stream for writing into a memory buffer. This is just a helper function, it doesn't do anything you couldn't do yourself in a callback function. It uses an internal callback that stores the pointer in stream *state* field. ::
408 pb_ostream_t pb_ostream_from_buffer(pb_byte_t *buf, size_t bufsize);
410 :buf: Memory buffer to write into.
411 :bufsize: Maximum number of bytes to write.
412 :returns: An output stream.
414 After writing, you can check *stream.bytes_written* to find out how much valid data there is in the buffer.
418 Writes data to an output stream. Always use this function, instead of trying to call stream callback manually. ::
420 bool pb_write(pb_ostream_t *stream, const pb_byte_t *buf, size_t count);
422 :stream: Output stream to write to.
423 :buf: Pointer to buffer with the data to be written.
424 :count: Number of bytes to write.
425 :returns: True on success, false if maximum length is exceeded or an IO error happens.
427 If an error happens, *bytes_written* is not incremented. Depending on the callback used, calling pb_write again after it has failed once may be dangerous. Nanopb itself never does this, instead it returns the error to user application. The builtin pb_ostream_from_buffer is safe to call again after failed write.
431 Encodes the contents of a structure as a protocol buffers message and writes it to output stream. ::
433 bool pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
435 :stream: Output stream to write to.
436 :fields: A field description array, usually autogenerated.
437 :src_struct: Pointer to the data that will be serialized.
438 :returns: True on success, false on IO error, on detectable errors in field description, or if a field encoder returns false.
440 Normally pb_encode simply walks through the fields description array and serializes each field in turn. However, submessages must be serialized twice: first to calculate their size and then to actually write them to output. This causes some constraints for callback fields, which must return the same data on every call.
444 Calculates the length of the message, encodes it as varint and then encodes the message. ::
446 bool pb_encode_delimited(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
448 (parameters are the same as for `pb_encode`_.)
450 A common way to indicate the message length in Protocol Buffers is to prefix it with a varint.
451 This function does this, and it is compatible with *parseDelimitedFrom* in Google's protobuf library.
453 .. sidebar:: Encoding fields manually
455 The functions with names *pb_encode_\** are used when dealing with callback fields. The typical reason for using callbacks is to have an array of unlimited size. In that case, `pb_encode`_ will call your callback function, which in turn will call *pb_encode_\** functions repeatedly to write out values.
457 The tag of a field must be encoded separately with `pb_encode_tag_for_field`_. After that, you can call exactly one of the content-writing functions to encode the payload of the field. For repeated fields, you can repeat this process multiple times.
459 Writing packed arrays is a little bit more involved: you need to use `pb_encode_tag` and specify `PB_WT_STRING` as the wire type. Then you need to know exactly how much data you are going to write, and use `pb_encode_varint`_ to write out the number of bytes before writing the actual data. Substreams can be used to determine the number of bytes beforehand; see `pb_encode_submessage`_ source code for an example.
463 Calculates the length of the encoded message. ::
465 bool pb_get_encoded_size(size_t *size, const pb_field_t fields[], const void *src_struct);
467 :size: Calculated size of the encoded message.
468 :fields: A field description array, usually autogenerated.
469 :src_struct: Pointer to the data that will be serialized.
470 :returns: True on success, false on detectable errors in field description or if a field encoder returns false.
474 Starts a field in the Protocol Buffers binary format: encodes the field number and the wire type of the data. ::
476 bool pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, uint32_t field_number);
478 :stream: Output stream to write to. 1-5 bytes will be written.
479 :wiretype: PB_WT_VARINT, PB_WT_64BIT, PB_WT_STRING or PB_WT_32BIT
480 :field_number: Identifier for the field, defined in the .proto file. You can get it from field->tag.
481 :returns: True on success, false on IO error.
483 pb_encode_tag_for_field
484 -----------------------
485 Same as `pb_encode_tag`_, except takes the parameters from a *pb_field_t* structure. ::
487 bool pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field);
489 :stream: Output stream to write to. 1-5 bytes will be written.
490 :field: Field description structure. Usually autogenerated.
491 :returns: True on success, false on IO error or unknown field type.
493 This function only considers the LTYPE of the field. You can use it from your field callbacks, because the source generator writes correct LTYPE also for callback type fields.
495 Wire type mapping is as follows:
497 ============================================= ============
499 ============================================= ============
500 VARINT, UVARINT, SVARINT PB_WT_VARINT
502 STRING, BYTES, SUBMESSAGE, FIXED_LENGTH_BYTES PB_WT_STRING
504 ============================================= ============
508 Encodes a signed or unsigned integer in the varint_ format. Works for fields of type `bool`, `enum`, `int32`, `int64`, `uint32` and `uint64`::
510 bool pb_encode_varint(pb_ostream_t *stream, uint64_t value);
512 :stream: Output stream to write to. 1-10 bytes will be written.
513 :value: Value to encode. Just cast e.g. int32_t directly to uint64_t.
514 :returns: True on success, false on IO error.
516 .. _varint: http://code.google.com/apis/protocolbuffers/docs/encoding.html#varints
520 Encodes a signed integer in the 'zig-zagged' format. Works for fields of type `sint32` and `sint64`::
522 bool pb_encode_svarint(pb_ostream_t *stream, int64_t value);
524 (parameters are the same as for `pb_encode_varint`_
528 Writes the length of a string as varint and then contents of the string. Works for fields of type `bytes` and `string`::
530 bool pb_encode_string(pb_ostream_t *stream, const pb_byte_t *buffer, size_t size);
532 :stream: Output stream to write to.
533 :buffer: Pointer to string data.
534 :size: Number of bytes in the string. Pass `strlen(s)` for strings.
535 :returns: True on success, false on IO error.
539 Writes 4 bytes to stream and swaps bytes on big-endian architectures. Works for fields of type `fixed32`, `sfixed32` and `float`::
541 bool pb_encode_fixed32(pb_ostream_t *stream, const void *value);
543 :stream: Output stream to write to.
544 :value: Pointer to a 4-bytes large C variable, for example `uint32_t foo;`.
545 :returns: True on success, false on IO error.
549 Writes 8 bytes to stream and swaps bytes on big-endian architecture. Works for fields of type `fixed64`, `sfixed64` and `double`::
551 bool pb_encode_fixed64(pb_ostream_t *stream, const void *value);
553 :stream: Output stream to write to.
554 :value: Pointer to a 8-bytes large C variable, for example `uint64_t foo;`.
555 :returns: True on success, false on IO error.
559 Encodes a submessage field, including the size header for it. Works for fields of any message type::
561 bool pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
563 :stream: Output stream to write to.
564 :fields: Pointer to the autogenerated field description array for the submessage type, e.g. `MyMessage_fields`.
565 :src: Pointer to the structure where submessage data is.
566 :returns: True on success, false on IO errors, pb_encode errors or if submessage size changes between calls.
568 In Protocol Buffers format, the submessage size must be written before the submessage contents. Therefore, this function has to encode the submessage twice in order to know the size beforehand.
570 If the submessage contains callback fields, the callback function might misbehave and write out a different amount of data on the second call. This situation is recognized and *false* is returned, but garbage will be written to the output before the problem is detected.
586 pb_istream_from_buffer
587 ----------------------
588 Helper function for creating an input stream that reads data from a memory buffer. ::
590 pb_istream_t pb_istream_from_buffer(const pb_byte_t *buf, size_t bufsize);
592 :buf: Pointer to byte array to read from.
593 :bufsize: Size of the byte array.
594 :returns: An input stream ready to use.
598 Read data from input stream. Always use this function, don't try to call the stream callback directly. ::
600 bool pb_read(pb_istream_t *stream, pb_byte_t *buf, size_t count);
602 :stream: Input stream to read from.
603 :buf: Buffer to store the data to, or NULL to just read data without storing it anywhere.
604 :count: Number of bytes to read.
605 :returns: True on success, false if *stream->bytes_left* is less than *count* or if an IO error occurs.
607 End of file is signalled by *stream->bytes_left* being zero after pb_read returns false.
611 Read and decode all fields of a structure. Reads until EOF on input stream. ::
613 bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
615 :stream: Input stream to read from.
616 :fields: A field description array. Usually autogenerated.
617 :dest_struct: Pointer to structure where data will be stored.
618 :returns: True on success, false on IO error, on detectable errors in field description, if a field encoder returns false or if a required field is missing.
620 In Protocol Buffers binary format, EOF is only allowed between fields. If it happens anywhere else, pb_decode will return *false*. If pb_decode returns false, you cannot trust any of the data in the structure.
622 In addition to EOF, the pb_decode implementation supports terminating a message with a 0 byte. This is compatible with the official Protocol Buffers because 0 is never a valid field tag.
624 For optional fields, this function applies the default value and sets *has_<field>* to false if the field is not present.
626 If *PB_ENABLE_MALLOC* is defined, this function may allocate storage for any pointer type fields.
627 In this case, you have to call `pb_release`_ to release the memory after you are done with the message.
628 On error return `pb_decode` will release the memory itself.
632 Same as `pb_decode`_, except does not apply the default values to fields. ::
634 bool pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
636 (parameters are the same as for `pb_decode`_.)
638 The destination structure should be filled with zeros before calling this function. Doing a *memset* manually can be slightly faster than using `pb_decode`_ if you don't need any default values.
640 In addition to decoding a single message, this function can be used to merge two messages, so that
641 values from previous message will remain if the new message does not contain a field.
643 This function *will not* release the message even on error return. If you use *PB_ENABLE_MALLOC*,
644 you will need to call `pb_release`_ yourself.
648 Same as `pb_decode`_, except that it first reads a varint with the length of the message. ::
650 bool pb_decode_delimited(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
652 (parameters are the same as for `pb_decode`_.)
654 A common method to indicate message size in Protocol Buffers is to prefix it with a varint.
655 This function is compatible with *writeDelimitedTo* in the Google's Protocol Buffers library.
659 Releases any dynamically allocated fields::
661 void pb_release(const pb_field_t fields[], void *dest_struct);
663 :fields: A field description array. Usually autogenerated.
664 :dest_struct: Pointer to structure where data is stored. If NULL, function does nothing.
666 This function is only available if *PB_ENABLE_MALLOC* is defined. It will release any
667 pointer type fields in the structure and set the pointers to NULL.
671 Decode the tag that comes before field in the protobuf encoding::
673 bool pb_decode_tag(pb_istream_t *stream, pb_wire_type_t *wire_type, uint32_t *tag, bool *eof);
675 :stream: Input stream to read from.
676 :wire_type: Pointer to variable where to store the wire type of the field.
677 :tag: Pointer to variable where to store the tag of the field.
678 :eof: Pointer to variable where to store end-of-file status.
679 :returns: True on success, false on error or EOF.
681 When the message (stream) ends, this function will return false and set *eof* to true. On other
682 errors, *eof* will be set to false.
686 Remove the data for a field from the stream, without actually decoding it::
688 bool pb_skip_field(pb_istream_t *stream, pb_wire_type_t wire_type);
690 :stream: Input stream to read from.
691 :wire_type: Type of field to skip.
692 :returns: True on success, false on IO error.
694 .. sidebar:: Decoding fields manually
696 The functions with names beginning with *pb_decode_* are used when dealing with callback fields. The typical reason for using callbacks is to have an array of unlimited size. In that case, `pb_decode`_ will call your callback function repeatedly, which can then store the values into e.g. filesystem in the order received in.
698 For decoding numeric (including enumerated and boolean) values, use `pb_decode_varint`_, `pb_decode_svarint`_, `pb_decode_fixed32`_ and `pb_decode_fixed64`_. They take a pointer to a 32- or 64-bit C variable, which you may then cast to smaller datatype for storage.
700 For decoding strings and bytes fields, the length has already been decoded. You can therefore check the total length in *stream->bytes_left* and read the data using `pb_read`_.
702 Finally, for decoding submessages in a callback, simply use `pb_decode`_ and pass it the *SubMessage_fields* descriptor array.
706 Read and decode a varint_ encoded integer. ::
708 bool pb_decode_varint(pb_istream_t *stream, uint64_t *dest);
710 :stream: Input stream to read from. 1-10 bytes will be read.
711 :dest: Storage for the decoded integer. Value is undefined on error.
712 :returns: True on success, false if value exceeds uint64_t range or an IO error happens.
716 Similar to `pb_decode_varint`_, except that it performs zigzag-decoding on the value. This corresponds to the Protocol Buffers *sint32* and *sint64* datatypes. ::
718 bool pb_decode_svarint(pb_istream_t *stream, int64_t *dest);
720 (parameters are the same as `pb_decode_varint`_)
724 Decode a *fixed32*, *sfixed32* or *float* value. ::
726 bool pb_decode_fixed32(pb_istream_t *stream, void *dest);
728 :stream: Input stream to read from. 4 bytes will be read.
729 :dest: Pointer to destination *int32_t*, *uint32_t* or *float*.
730 :returns: True on success, false on IO errors.
732 This function reads 4 bytes from the input stream.
733 On big endian architectures, it then reverses the order of the bytes.
734 Finally, it writes the bytes to *dest*.
738 Decode a *fixed64*, *sfixed64* or *double* value. ::
740 bool pb_decode_fixed64(pb_istream_t *stream, void *dest);
742 :stream: Input stream to read from. 8 bytes will be read.
743 :dest: Pointer to destination *int64_t*, *uint64_t* or *double*.
744 :returns: True on success, false on IO errors.
746 Same as `pb_decode_fixed32`_, except this reads 8 bytes.
748 pb_make_string_substream
749 ------------------------
750 Decode the length for a field with wire type *PB_WT_STRING* and create a substream for reading the data. ::
752 bool pb_make_string_substream(pb_istream_t *stream, pb_istream_t *substream);
754 :stream: Original input stream to read the length and data from.
755 :substream: New substream that has limited length. Filled in by the function.
756 :returns: True on success, false if reading the length fails.
758 This function uses `pb_decode_varint`_ to read an integer from the stream. This is interpreted as a number of bytes, and the substream is set up so that its `bytes_left` is initially the same as the length, and its callback function and state the same as the parent stream.
760 pb_close_string_substream
761 -------------------------
762 Close the substream created with `pb_make_string_substream`_. ::
764 void pb_close_string_substream(pb_istream_t *stream, pb_istream_t *substream);
766 :stream: Original input stream to read the length and data from.
767 :substream: Substream to close
769 This function copies back the state from the substream to the parent stream.
770 It must be called after done with the substream.