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 __BIG_ENDIAN__ Set this if your platform stores integers and
24 floats in big-endian format. Mixed-endian
25 systems (different layout for ints and floats)
26 are currently not supported.
27 PB_NO_PACKED_STRUCTS Disable packed structs. Increases RAM usage but
28 is necessary on some platforms that do not
29 support unaligned memory access.
30 PB_ENABLE_MALLOC Set this to enable dynamic allocation support
32 PB_MAX_REQUIRED_FIELDS Maximum number of required fields to check for
33 presence. Default value is 64. Increases stack
34 usage 1 byte per every 8 fields. Compiler
35 warning will tell if you need this.
36 PB_FIELD_16BIT Add support for tag numbers > 255 and fields
37 larger than 255 bytes or 255 array entries.
38 Increases code size 3 bytes per each field.
39 Compiler error will tell if you need this.
40 PB_FIELD_32BIT Add support for tag numbers > 65535 and fields
41 larger than 65535 bytes or 65535 array entries.
42 Increases code size 9 bytes per each field.
43 Compiler error will tell if you need this.
44 PB_NO_ERRMSG Disables the support for error messages; only
45 error information is the true/false return
46 value. Decreases the code size by a few hundred
48 PB_BUFFER_ONLY Disables the support for custom streams. Only
49 supports encoding and decoding with memory
50 buffers. Speeds up execution and decreases code
52 PB_OLD_CALLBACK_STYLE Use the old function signature (void\* instead
53 of void\*\*) for callback fields. This was the
54 default until nanopb-0.2.1.
55 PB_SYSTEM_HEADER Replace the standard header files with a single
56 header file. It should define all the required
57 functions and typedefs listed on the
58 `overview page`_. Value must include quotes,
59 for example *#define PB_SYSTEM_HEADER "foo.h"*.
60 ============================ ================================================
62 The PB_MAX_REQUIRED_FIELDS, PB_FIELD_16BIT and PB_FIELD_32BIT settings allow
63 raising some datatype limits to suit larger messages. Their need is recognized
64 automatically by C-preprocessor #if-directives in the generated .pb.h files.
65 The default setting is to use the smallest datatypes (least resources used).
67 .. _`overview page`: index.html#compiler-requirements
72 The generator behaviour can be adjusted using these options, defined in the
73 'nanopb.proto' file in the generator folder:
75 ============================ ================================================
76 max_size Allocated size for *bytes* and *string* fields.
77 max_count Allocated number of entries in arrays
79 int_size Override the integer type of a field.
80 (To use e.g. uint8_t to save RAM.)
81 type Type of the generated field. Default value
82 is *FT_DEFAULT*, which selects automatically.
83 You can use *FT_CALLBACK*, *FT_POINTER*,
84 *FT_STATIC* or *FT_IGNORE* to force a callback
85 field, a dynamically allocated field, a static
86 field or to completely ignore the field.
87 long_names Prefix the enum name to the enum value in
88 definitions, i.e. *EnumName_EnumValue*. Enabled
90 packed_struct Make the generated structures packed.
91 NOTE: This cannot be used on CPUs that break
92 on unaligned accesses to variables.
93 skip_message Skip the whole message from generation.
94 no_unions Generate 'oneof' fields as optional fields
96 msgid Specifies a unique id for this message type.
97 Can be used by user code as an identifier.
98 ============================ ================================================
100 These options can be defined for the .proto files before they are converted
101 using the nanopb-generatory.py. There are three ways to define the options:
103 1. Using a separate .options file.
104 This is the preferred way as of nanopb-0.2.1, because it has the best
105 compatibility with other protobuf libraries.
106 2. Defining the options on the command line of nanopb_generator.py.
107 This only makes sense for settings that apply to a whole file.
108 3. Defining the options in the .proto file using the nanopb extensions.
109 This is the way used in nanopb-0.1, and will remain supported in the
110 future. It however sometimes causes trouble when using the .proto file
111 with other protobuf libraries.
113 The effect of the options is the same no matter how they are given. The most
114 common purpose is to define maximum size for string fields in order to
115 statically allocate them.
117 Defining the options in a .options file
118 ---------------------------------------
119 The preferred way to define options is to have a separate file
120 'myproto.options' in the same directory as the 'myproto.proto'. ::
124 required string name = 1;
125 repeated int32 ids = 4;
131 MyMessage.name max_size:40
132 MyMessage.ids max_count:5
134 The generator will automatically search for this file and read the
135 options from it. The file format is as follows:
137 * Lines starting with '#' or '//' are regarded as comments.
138 * Blank lines are ignored.
139 * All other lines should start with a field name pattern, followed by one or
140 more options. For example: *"MyMessage.myfield max_size:5 max_count:10"*.
141 * The field name pattern is matched against a string of form *'Message.field'*.
142 For nested messages, the string is *'Message.SubMessage.field'*.
143 * The field name pattern may use the notation recognized by Python fnmatch():
145 - *\** matches any part of string, like 'Message.\*' for all fields
146 - *\?* matches any single character
147 - *[seq]* matches any of characters 's', 'e' and 'q'
148 - *[!seq]* matches any other character
150 * The options are written as *'option_name:option_value'* and several options
151 can be defined on same line, separated by whitespace.
152 * Options defined later in the file override the ones specified earlier, so
153 it makes sense to define wildcard options first in the file and more specific
156 If preferred, the name of the options file can be set using the command line
157 switch *-f* to nanopb_generator.py.
159 Defining the options on command line
160 ------------------------------------
161 The nanopb_generator.py has a simple command line option *-s OPTION:VALUE*.
162 The setting applies to the whole file that is being processed.
164 Defining the options in the .proto file
165 ---------------------------------------
166 The .proto file format allows defining custom options for the fields.
167 The nanopb library comes with *nanopb.proto* which does exactly that, allowing
168 you do define the options directly in the .proto file::
170 import "nanopb.proto";
173 required string name = 1 [(nanopb).max_size = 40];
174 repeated int32 ids = 4 [(nanopb).max_count = 5];
177 A small complication is that you have to set the include path of protoc so that
178 nanopb.proto can be found. This file, in turn, requires the file
179 *google/protobuf/descriptor.proto*. This is usually installed under
180 */usr/include*. Therefore, to compile a .proto file which uses options, use a
181 protoc command similar to::
183 protoc -I/usr/include -Inanopb/generator -I. -omessage.pb message.proto
185 The options can be defined in file, message and field scopes::
187 option (nanopb_fileopt).max_size = 20; // File scope
190 option (nanopb_msgopt).max_size = 30; // Message scope
191 required string fieldsize = 1 [(nanopb).max_size = 40]; // Field scope
207 Defines the encoder/decoder behaviour that should be used for a field. ::
209 typedef uint8_t pb_type_t;
211 The low-order nibble of the enumeration values defines the function that can be used for encoding and decoding the field data:
213 ==================== ===== ================================================
214 LTYPE identifier Value Storage format
215 ==================== ===== ================================================
216 PB_LTYPE_VARINT 0x00 Integer.
217 PB_LTYPE_SVARINT 0x01 Integer, zigzag encoded.
218 PB_LTYPE_FIXED32 0x02 32-bit integer or floating point.
219 PB_LTYPE_FIXED64 0x03 64-bit integer or floating point.
220 PB_LTYPE_BYTES 0x04 Structure with *size_t* field and byte array.
221 PB_LTYPE_STRING 0x05 Null-terminated string.
222 PB_LTYPE_SUBMESSAGE 0x06 Submessage structure.
223 ==================== ===== ================================================
225 The bits 4-5 define whether the field is required, optional or repeated:
227 ==================== ===== ================================================
228 HTYPE identifier Value Field handling
229 ==================== ===== ================================================
230 PB_HTYPE_REQUIRED 0x00 Verify that field exists in decoded message.
231 PB_HTYPE_OPTIONAL 0x10 Use separate *has_<field>* boolean to specify
232 whether the field is present.
233 (Unless it is a callback)
234 PB_HTYPE_REPEATED 0x20 A repeated field with preallocated array.
235 Separate *<field>_count* for number of items.
236 (Unless it is a callback)
237 ==================== ===== ================================================
239 The bits 6-7 define the how the storage for the field is allocated:
241 ==================== ===== ================================================
242 ATYPE identifier Value Allocation method
243 ==================== ===== ================================================
244 PB_ATYPE_STATIC 0x00 Statically allocated storage in the structure.
245 PB_ATYPE_CALLBACK 0x40 A field with dynamic storage size. Struct field
246 actually contains a pointer to a callback
248 ==================== ===== ================================================
253 Describes a single structure field with memory position in relation to others. The descriptions are usually autogenerated. ::
255 typedef struct _pb_field_t pb_field_t;
266 :tag: Tag number of the field or 0 to terminate a list of fields.
267 :type: LTYPE, HTYPE and ATYPE of the field.
268 :data_offset: Offset of field data, relative to the end of the previous field.
269 :size_offset: Offset of *bool* flag for optional fields or *size_t* count for arrays, relative to field data.
270 :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.
271 :array_size: Maximum number of entries in an array, if it is an array type.
272 :ptr: Pointer to default value for optional fields, or to submessage description for PB_LTYPE_SUBMESSAGE.
274 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*.
278 An byte array with a field for storing the length::
285 In an actual array, the length of *bytes* may be different.
289 Part of a message structure, for fields with type PB_HTYPE_CALLBACK::
291 typedef struct _pb_callback_t pb_callback_t;
292 struct _pb_callback_t {
294 bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void **arg);
295 bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, void * const *arg);
301 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.
303 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*.
305 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.
309 Protocol Buffers wire types. These are used with `pb_encode_tag`_. ::
320 Defines the handler functions and auxiliary data for a field that extends
321 another message. Usually autogenerated by *nanopb_generator.py*::
324 bool (*decode)(pb_istream_t *stream, pb_extension_t *extension,
325 uint32_t tag, pb_wire_type_t wire_type);
326 bool (*encode)(pb_ostream_t *stream, const pb_extension_t *extension);
328 } pb_extension_type_t;
330 In the normal case, the function pointers are *NULL* and the decoder and
331 encoder use their internal implementations. The internal implementations
332 assume that *arg* points to a *pb_field_t* that describes the field in question.
334 To implement custom processing of unknown fields, you can provide pointers
335 to your own functions. Their functionality is mostly the same as for normal
336 callback fields, except that they get called for any unknown field when decoding.
340 Ties together the extension field type and the storage for the field value::
343 const pb_extension_type_t *type;
345 pb_extension_t *next;
348 :type: Pointer to the structure that defines the callback functions.
349 :dest: Pointer to the variable that stores the field value
350 (as used by the default extension callback functions.)
351 :next: Pointer to the next extension handler, or *NULL*.
355 Get the current error message from a stream, or a placeholder string if
356 there is no error message::
358 #define PB_GET_ERROR(stream) (string expression)
360 This should be used for printing errors, for example::
364 printf("Decode failed: %s\n", PB_GET_ERROR(stream));
367 The macro only returns pointers to constant strings (in code memory),
368 so that there is no need to release the returned pointer.
372 Set the error message and return false::
374 #define PB_RETURN_ERROR(stream,msg) (sets error and returns false)
376 This should be used to handle error conditions inside nanopb functions
377 and user callback functions::
381 PB_RETURN_ERROR(stream, "something went wrong");
384 The *msg* parameter must be a constant string.
391 pb_ostream_from_buffer
392 ----------------------
393 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. ::
395 pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize);
397 :buf: Memory buffer to write into.
398 :bufsize: Maximum number of bytes to write.
399 :returns: An output stream.
401 After writing, you can check *stream.bytes_written* to find out how much valid data there is in the buffer.
405 Writes data to an output stream. Always use this function, instead of trying to call stream callback manually. ::
407 bool pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count);
409 :stream: Output stream to write to.
410 :buf: Pointer to buffer with the data to be written.
411 :count: Number of bytes to write.
412 :returns: True on success, false if maximum length is exceeded or an IO error happens.
414 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.
418 Encodes the contents of a structure as a protocol buffers message and writes it to output stream. ::
420 bool pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
422 :stream: Output stream to write to.
423 :fields: A field description array, usually autogenerated.
424 :src_struct: Pointer to the data that will be serialized.
425 :returns: True on success, false on IO error, on detectable errors in field description, or if a field encoder returns false.
427 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.
431 Calculates the length of the message, encodes it as varint and then encodes the message. ::
433 bool pb_encode_delimited(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
435 (parameters are the same as for `pb_encode`_.)
437 A common way to indicate the message length in Protocol Buffers is to prefix it with a varint.
438 This function does this, and it is compatible with *parseDelimitedFrom* in Google's protobuf library.
440 .. sidebar:: Encoding fields manually
442 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.
444 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.
446 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.
450 Starts a field in the Protocol Buffers binary format: encodes the field number and the wire type of the data. ::
452 bool pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, int field_number);
454 :stream: Output stream to write to. 1-5 bytes will be written.
455 :wiretype: PB_WT_VARINT, PB_WT_64BIT, PB_WT_STRING or PB_WT_32BIT
456 :field_number: Identifier for the field, defined in the .proto file. You can get it from field->tag.
457 :returns: True on success, false on IO error.
459 pb_encode_tag_for_field
460 -----------------------
461 Same as `pb_encode_tag`_, except takes the parameters from a *pb_field_t* structure. ::
463 bool pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field);
465 :stream: Output stream to write to. 1-5 bytes will be written.
466 :field: Field description structure. Usually autogenerated.
467 :returns: True on success, false on IO error or unknown field type.
469 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.
471 Wire type mapping is as follows:
473 ========================= ============
475 ========================= ============
476 VARINT, SVARINT PB_WT_VARINT
478 STRING, BYTES, SUBMESSAGE PB_WT_STRING
480 ========================= ============
484 Encodes a signed or unsigned integer in the varint_ format. Works for fields of type `bool`, `enum`, `int32`, `int64`, `uint32` and `uint64`::
486 bool pb_encode_varint(pb_ostream_t *stream, uint64_t value);
488 :stream: Output stream to write to. 1-10 bytes will be written.
489 :value: Value to encode. Just cast e.g. int32_t directly to uint64_t.
490 :returns: True on success, false on IO error.
492 .. _varint: http://code.google.com/apis/protocolbuffers/docs/encoding.html#varints
496 Encodes a signed integer in the 'zig-zagged' format. Works for fields of type `sint32` and `sint64`::
498 bool pb_encode_svarint(pb_ostream_t *stream, int64_t value);
500 (parameters are the same as for `pb_encode_varint`_
504 Writes the length of a string as varint and then contents of the string. Works for fields of type `bytes` and `string`::
506 bool pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size);
508 :stream: Output stream to write to.
509 :buffer: Pointer to string data.
510 :size: Number of bytes in the string. Pass `strlen(s)` for strings.
511 :returns: True on success, false on IO error.
515 Writes 4 bytes to stream and swaps bytes on big-endian architectures. Works for fields of type `fixed32`, `sfixed32` and `float`::
517 bool pb_encode_fixed32(pb_ostream_t *stream, const void *value);
519 :stream: Output stream to write to.
520 :value: Pointer to a 4-bytes large C variable, for example `uint32_t foo;`.
521 :returns: True on success, false on IO error.
525 Writes 8 bytes to stream and swaps bytes on big-endian architecture. Works for fields of type `fixed64`, `sfixed64` and `double`::
527 bool pb_encode_fixed64(pb_ostream_t *stream, const void *value);
529 :stream: Output stream to write to.
530 :value: Pointer to a 8-bytes large C variable, for example `uint64_t foo;`.
531 :returns: True on success, false on IO error.
535 Encodes a submessage field, including the size header for it. Works for fields of any message type::
537 bool pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
539 :stream: Output stream to write to.
540 :fields: Pointer to the autogenerated field description array for the submessage type, e.g. `MyMessage_fields`.
541 :src: Pointer to the structure where submessage data is.
542 :returns: True on success, false on IO errors, pb_encode errors or if submessage size changes between calls.
544 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.
546 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.
562 pb_istream_from_buffer
563 ----------------------
564 Helper function for creating an input stream that reads data from a memory buffer. ::
566 pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize);
568 :buf: Pointer to byte array to read from.
569 :bufsize: Size of the byte array.
570 :returns: An input stream ready to use.
574 Read data from input stream. Always use this function, don't try to call the stream callback directly. ::
576 bool pb_read(pb_istream_t *stream, uint8_t *buf, size_t count);
578 :stream: Input stream to read from.
579 :buf: Buffer to store the data to, or NULL to just read data without storing it anywhere.
580 :count: Number of bytes to read.
581 :returns: True on success, false if *stream->bytes_left* is less than *count* or if an IO error occurs.
583 End of file is signalled by *stream->bytes_left* being zero after pb_read returns false.
587 Read and decode all fields of a structure. Reads until EOF on input stream. ::
589 bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
591 :stream: Input stream to read from.
592 :fields: A field description array. Usually autogenerated.
593 :dest_struct: Pointer to structure where data will be stored.
594 :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.
596 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.
598 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.
600 For optional fields, this function applies the default value and sets *has_<field>* to false if the field is not present.
602 If *PB_ENABLE_MALLOC* is defined, this function may allocate storage for any pointer type fields.
603 In this case, you have to call `pb_release`_ to release the memory after you are done with the message.
604 On error return `pb_decode` will release the memory itself.
608 Same as `pb_decode`_, except does not apply the default values to fields. ::
610 bool pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
612 (parameters are the same as for `pb_decode`_.)
614 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.
616 In addition to decoding a single message, this function can be used to merge two messages, so that
617 values from previous message will remain if the new message does not contain a field.
619 This function *will not* release the message even on error return. If you use *PB_ENABLE_MALLOC*,
620 you will need to call `pb_release`_ yourself.
624 Same as `pb_decode`_, except that it first reads a varint with the length of the message. ::
626 bool pb_decode_delimited(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
628 (parameters are the same as for `pb_decode`_.)
630 A common method to indicate message size in Protocol Buffers is to prefix it with a varint.
631 This function is compatible with *writeDelimitedTo* in the Google's Protocol Buffers library.
635 Releases any dynamically allocated fields.
637 void pb_release(const pb_field_t fields[], void *dest_struct);
639 :fields: A field description array. Usually autogenerated.
640 :dest_struct: Pointer to structure where data will be stored.
642 This function is only available if *PB_ENABLE_MALLOC* is defined. It will release any
643 pointer type fields in the structure and set the pointers to NULL.
647 Skip a varint_ encoded integer without decoding it. ::
649 bool pb_skip_varint(pb_istream_t *stream);
651 :stream: Input stream to read from. Will read 1 byte at a time until the MSB is clear.
652 :returns: True on success, false on IO error.
656 Skip a varint-length-prefixed string. This means skipping a value with wire type PB_WT_STRING. ::
658 bool pb_skip_string(pb_istream_t *stream);
660 :stream: Input stream to read from.
661 :returns: True on success, false on IO error or length exceeding uint32_t.
665 Decode the tag that comes before field in the protobuf encoding::
667 bool pb_decode_tag(pb_istream_t *stream, pb_wire_type_t *wire_type, int *tag, bool *eof);
669 :stream: Input stream to read from.
670 :wire_type: Pointer to variable where to store the wire type of the field.
671 :tag: Pointer to variable where to store the tag of the field.
672 :eof: Pointer to variable where to store end-of-file status.
673 :returns: True on success, false on error or EOF.
675 When the message (stream) ends, this function will return false and set *eof* to true. On other
676 errors, *eof* will be set to false.
680 Remove the data for a field from the stream, without actually decoding it::
682 bool pb_skip_field(pb_istream_t *stream, pb_wire_type_t wire_type);
684 :stream: Input stream to read from.
685 :wire_type: Type of field to skip.
686 :returns: True on success, false on IO error.
688 .. sidebar:: Decoding fields manually
690 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.
692 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.
694 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`_.
696 Finally, for decoding submessages in a callback, simply use `pb_decode`_ and pass it the *SubMessage_fields* descriptor array.
700 Read and decode a varint_ encoded integer. ::
702 bool pb_decode_varint(pb_istream_t *stream, uint64_t *dest);
704 :stream: Input stream to read from. 1-10 bytes will be read.
705 :dest: Storage for the decoded integer. Value is undefined on error.
706 :returns: True on success, false if value exceeds uint64_t range or an IO error happens.
710 Similar to `pb_decode_varint`_, except that it performs zigzag-decoding on the value. This corresponds to the Protocol Buffers *sint32* and *sint64* datatypes. ::
712 bool pb_decode_svarint(pb_istream_t *stream, int64_t *dest);
714 (parameters are the same as `pb_decode_varint`_)
718 Decode a *fixed32*, *sfixed32* or *float* value. ::
720 bool pb_decode_fixed32(pb_istream_t *stream, void *dest);
722 :stream: Input stream to read from. 4 bytes will be read.
723 :dest: Pointer to destination *int32_t*, *uint32_t* or *float*.
724 :returns: True on success, false on IO errors.
726 This function reads 4 bytes from the input stream.
727 On big endian architectures, it then reverses the order of the bytes.
728 Finally, it writes the bytes to *dest*.
732 Decode a *fixed64*, *sfixed64* or *double* value. ::
734 bool pb_dec_fixed(pb_istream_t *stream, const pb_field_t *field, void *dest);
736 :stream: Input stream to read from. 8 bytes will be read.
738 :dest: Pointer to destination *int64_t*, *uint64_t* or *double*.
739 :returns: True on success, false on IO errors.
741 Same as `pb_decode_fixed32`_, except this reads 8 bytes.
743 pb_make_string_substream
744 ------------------------
745 Decode the length for a field with wire type *PB_WT_STRING* and create a substream for reading the data. ::
747 bool pb_make_string_substream(pb_istream_t *stream, pb_istream_t *substream);
749 :stream: Original input stream to read the length and data from.
750 :substream: New substream that has limited length. Filled in by the function.
751 :returns: True on success, false if reading the length fails.
753 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.
755 pb_close_string_substream
756 -------------------------
757 Close the substream created with `pb_make_string_substream`_. ::
759 void pb_close_string_substream(pb_istream_t *stream, pb_istream_t *substream);
761 :stream: Original input stream to read the length and data from.
762 :substream: Substream to close
764 This function copies back the state from the substream to the parent stream.
765 It must be called after done with the substream.