docs/reference.rst

   1 =====================
   2 Nanopb: API reference
   3 =====================
   4
   5 .. include :: menu.rst
   6
   7 .. contents ::
   8
   9
  10
  11
  12 Compilation options
  13 ===================
  14 The following options can be specified in one of two ways:
  15
  16 1. Using the -D switch on the C compiler command line.
  17 2. By #defining them at the top of pb.h.
  18
  19 You must have the same settings for the nanopb library and all code that
  20 includes pb.h.
  21
  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 NANOPB_INTERNALS               Set this to expose the field encoder functions
  28                                that are hidden since nanopb-0.1.3.
  29 PB_MAX_REQUIRED_FIELDS         Maximum number of required fields to check for
  30                                presence. Default value is 64. Increases stack
  31                                usage 1 byte per every 8 fields. Compiler
  32                                warning will tell if you need this.
  33 PB_FIELD_16BIT                 Add support for tag numbers > 255 and fields
  34                                larger than 255 bytes or 255 array entries.
  35                                Increases code size 3 bytes per each field.
  36                                Compiler error will tell if you need this.
  37 PB_FIELD_32BIT                 Add support for tag numbers > 65535 and fields
  38                                larger than 65535 bytes or 65535 array entries.
  39                                Increases code size 9 bytes per each field.
  40                                Compiler error will tell if you need this.
  41 PB_NO_ERRMSG                   Disables the support for error messages; only
  42                                error information is the true/false return
  43                                value. Decreases the code size by a few hundred
  44                                bytes.
  45 PB_BUFFER_ONLY                 Disables the support for custom streams. Only
  46                                supports encoding and decoding with memory
  47                                buffers. Speeds up execution and decreases code
  48                                size slightly.
  49 PB_OLD_CALLBACK_STYLE          Use the old function signature (void\* instead
  50                                of void\*\*) for callback fields. This was the
  51                                default until nanopb-0.2.1.
  52 ============================  ================================================
  53
  54 The PB_MAX_REQUIRED_FIELDS, PB_FIELD_16BIT and PB_FIELD_32BIT settings allow
  55 raising some datatype limits to suit larger messages. Their need is recognized
  56 automatically by C-preprocessor #if-directives in the generated .pb.h files.
  57 The default setting is to use the smallest datatypes (least resources used).
  58
  59
  60
  61
  62 Proto file options
  63 ==================
  64 The generator behaviour can be adjusted using these options, defined in the
  65 'nanopb.proto' file in the generator folder:
  66
  67 ============================  ================================================
  68 max_size                       Allocated size for *bytes* and *string* fields.
  69 max_count                      Allocated number of entries in arrays
  70                                (*repeated* fields).
  71 type                           Type of the generated field. Default value
  72                                is *FT_DEFAULT*, which selects automatically.
  73                                You can use *FT_CALLBACK*, *FT_STATIC* or
  74                                *FT_IGNORE* to force a callback field, a static
  75                                field or to completely ignore the field.
  76 long_names                     Prefix the enum name to the enum value in
  77                                definitions, i.e. *EnumName_EnumValue*. Enabled
  78                                by default.
  79 packed_struct                  Make the generated structures packed.
  80                                NOTE: This cannot be used on CPUs that break
  81                                on unaligned accesses to variables.
  82 ============================  ================================================
  83
  84 These options can be defined for the .proto files before they are converted
  85 using the nanopb-generatory.py. There are three ways to define the options:
  86
  87 1. Using a separate .options file.
  88    This is the preferred way as of nanopb-0.2.1, because it has the best
  89    compatibility with other protobuf libraries.
  90 2. Defining the options on the command line of nanopb_generator.py.
  91    This only makes sense for settings that apply to a whole file.
  92 3. Defining the options in the .proto file using the nanopb extensions.
  93    This is the way used in nanopb-0.1, and will remain supported in the
  94    future. It however sometimes causes trouble when using the .proto file
  95    with other protobuf libraries.
  96
  97 The effect of the options is the same no matter how they are given. The most
  98 common purpose is to define maximum size for string fields in order to
  99 statically allocate them.
 100
 101 Defining the options in a .options file
 102 ---------------------------------------
 103 The preferred way to define options is to have a separate file
 104 'myproto.options' in the same directory as the 'myproto.proto'. ::
 105
 106     # myproto.proto
 107     message MyMessage {
 108         required string name = 1;
 109         repeated int32 ids = 4;
 110     }
 111
 112 ::
 113
 114     # myproto.options
 115     MyMessage.name         max_size:40
 116     MyMessage.ids          max_count:5
 117
 118 The generator will automatically search for this file and read the
 119 options from it. The file format is as follows:
 120
 121 * Lines starting with '#' or '//' are regarded as comments.
 122 * Blank lines are ignored.
 123 * All other lines should start with a field name pattern, followed by one or
 124   more options. For example: *"MyMessage.myfield max_size:5 max_count:10"*.
 125 * The field name pattern is matched against a string of form *'Message.field'*.
 126   For nested messages, the string is *'Message.SubMessage.field'*.
 127 * The field name pattern may use the notation recognized by Python fnmatch():
 128
 129   - *\** matches any part of string, like 'Message.\*' for all fields
 130   - *\?* matches any single character
 131   - *[seq]* matches any of characters 's', 'e' and 'q'
 132   - *[!seq]* matches any other character
 133
 134 * The options are written as *'option_name:option_value'* and several options
 135   can be defined on same line, separated by whitespace.
 136 * Options defined later in the file override the ones specified earlier, so
 137   it makes sense to define wildcard options first in the file and more specific
 138   ones later.
 139
 140 If preferred, the name of the options file can be set using the command line
 141 switch *-f* to nanopb_generator.py.
 142
 143 Defining the options on command line
 144 ------------------------------------
 145 The nanopb_generator.py has a simple command line option *-s OPTION:VALUE*.
 146 The setting applies to the whole file that is being processed.
 147
 148 Defining the options in the .proto file
 149 ---------------------------------------
 150 The .proto file format allows defining custom options for the fields.
 151 The nanopb library comes with *nanopb.proto* which does exactly that, allowing
 152 you do define the options directly in the .proto file::
 153
 154     import "nanopb.proto";
 155
 156     message MyMessage {
 157         required string name = 1 [(nanopb).max_size = 40];
 158         repeated int32 ids = 4   [(nanopb).max_count = 5];
 159     }
 160
 161 A small complication is that you have to set the include path of protoc so that
 162 nanopb.proto can be found. This file, in turn, requires the file
 163 *google/protobuf/descriptor.proto*. This is usually installed under
 164 */usr/include*. Therefore, to compile a .proto file which uses options, use a
 165 protoc command similar to::
 166
 167     protoc -I/usr/include -Inanopb/generator -I. -omessage.pb message.proto
 168
 169 The options can be defined in file, message and field scopes::
 170
 171     option (nanopb_fileopt).max_size = 20; // File scope
 172     message Message
 173     {
 174         option (nanopb_msgopt).max_size = 30; // Message scope
 175         required string fieldsize = 1 [(nanopb).max_size = 40]; // Field scope
 176     }
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186 pb.h
 187 ====
 188
 189 pb_type_t
 190 ---------
 191 Defines the encoder/decoder behaviour that should be used for a field. ::
 192
 193     typedef uint8_t pb_type_t;
 194
 195 The low-order nibble of the enumeration values defines the function that can be used for encoding and decoding the field data:
 196
 197 ==================== ===== ================================================
 198 LTYPE identifier     Value Storage format
 199 ==================== ===== ================================================
 200 PB_LTYPE_VARINT      0x00  Integer.
 201 PB_LTYPE_SVARINT     0x01  Integer, zigzag encoded.
 202 PB_LTYPE_FIXED32     0x02  32-bit integer or floating point.
 203 PB_LTYPE_FIXED64     0x03  64-bit integer or floating point.
 204 PB_LTYPE_BYTES       0x04  Structure with *size_t* field and byte array.
 205 PB_LTYPE_STRING      0x05  Null-terminated string.
 206 PB_LTYPE_SUBMESSAGE  0x06  Submessage structure.
 207 ==================== ===== ================================================
 208
 209 The bits 4-5 define whether the field is required, optional or repeated:
 210
 211 ==================== ===== ================================================
 212 HTYPE identifier     Value Field handling
 213 ==================== ===== ================================================
 214 PB_HTYPE_REQUIRED    0x00  Verify that field exists in decoded message.
 215 PB_HTYPE_OPTIONAL    0x10  Use separate *has_<field>* boolean to specify
 216                            whether the field is present.
 217                            (Unless it is a callback)
 218 PB_HTYPE_REPEATED    0x20  A repeated field with preallocated array.
 219                            Separate *<field>_count* for number of items.
 220                            (Unless it is a callback)
 221 ==================== ===== ================================================
 222
 223 The bits 6-7 define the how the storage for the field is allocated:
 224
 225 ==================== ===== ================================================
 226 ATYPE identifier     Value Allocation method
 227 ==================== ===== ================================================
 228 PB_ATYPE_STATIC      0x00  Statically allocated storage in the structure.
 229 PB_ATYPE_CALLBACK    0x40  A field with dynamic storage size. Struct field
 230                            actually contains a pointer to a callback
 231                            function.
 232 ==================== ===== ================================================
 233
 234
 235 pb_field_t
 236 ----------
 237 Describes a single structure field with memory position in relation to others. The descriptions are usually autogenerated. ::
 238
 239     typedef struct _pb_field_t pb_field_t;
 240     struct _pb_field_t {
 241         uint8_t tag;
 242         pb_type_t type;
 243         uint8_t data_offset;
 244         int8_t size_offset;
 245         uint8_t data_size;
 246         uint8_t array_size;
 247         const void *ptr;
 248     } pb_packed;
 249
 250 :tag:           Tag number of the field or 0 to terminate a list of fields.
 251 :type:          LTYPE, HTYPE and ATYPE of the field.
 252 :data_offset:   Offset of field data, relative to the end of the previous field.
 253 :size_offset:   Offset of *bool* flag for optional fields or *size_t* count for arrays, relative to field data.
 254 :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.
 255 :array_size:    Maximum number of entries in an array, if it is an array type.
 256 :ptr:           Pointer to default value for optional fields, or to submessage description for PB_LTYPE_SUBMESSAGE.
 257
 258 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*.
 259
 260 pb_bytes_array_t
 261 ----------------
 262 An byte array with a field for storing the length::
 263
 264     typedef struct {
 265         size_t size;
 266         uint8_t bytes[1];
 267     } pb_bytes_array_t;
 268
 269 In an actual array, the length of *bytes* may be different.
 270
 271 pb_callback_t
 272 -------------
 273 Part of a message structure, for fields with type PB_HTYPE_CALLBACK::
 274
 275     typedef struct _pb_callback_t pb_callback_t;
 276     struct _pb_callback_t {
 277         union {
 278             bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void **arg);
 279             bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, void * const *arg);
 280         } funcs;
 281
 282         void *arg;
 283     };
 284
 285 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.
 286
 287 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*.
 288
 289 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.
 290
 291 pb_wire_type_t
 292 --------------
 293 Protocol Buffers wire types. These are used with `pb_encode_tag`_. ::
 294
 295     typedef enum {
 296         PB_WT_VARINT = 0,
 297         PB_WT_64BIT  = 1,
 298         PB_WT_STRING = 2,
 299         PB_WT_32BIT  = 5
 300     } pb_wire_type_t;
 301
 302 PB_GET_ERROR
 303 ------------
 304 Get the current error message from a stream, or a placeholder string if
 305 there is no error message::
 306
 307     #define PB_GET_ERROR(stream) (string expression)
 308
 309 This should be used for printing errors, for example::
 310
 311     if (!pb_decode(...))
 312     {
 313         printf("Decode failed: %s\n", PB_GET_ERROR(stream));
 314     }
 315
 316 The macro only returns pointers to constant strings (in code memory),
 317 so that there is no need to release the returned pointer.
 318
 319 PB_RETURN_ERROR
 320 ---------------
 321 Set the error message and return false::
 322
 323     #define PB_RETURN_ERROR(stream,msg) (sets error and returns false)
 324
 325 This should be used to handle error conditions inside nanopb functions
 326 and user callback functions::
 327
 328     if (error_condition)
 329     {
 330         PB_RETURN_ERROR(stream, "something went wrong");
 331     }
 332
 333 The *msg* parameter must be a constant string.
 334
 335
 336
 337 pb_encode.h
 338 ===========
 339
 340 pb_ostream_from_buffer
 341 ----------------------
 342 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. ::
 343
 344     pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize);
 345
 346 :buf:           Memory buffer to write into.
 347 :bufsize:       Maximum number of bytes to write.
 348 :returns:       An output stream.
 349
 350 After writing, you can check *stream.bytes_written* to find out how much valid data there is in the buffer.
 351
 352 pb_write
 353 --------
 354 Writes data to an output stream. Always use this function, instead of trying to call stream callback manually. ::
 355
 356     bool pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count);
 357
 358 :stream:        Output stream to write to.
 359 :buf:           Pointer to buffer with the data to be written.
 360 :count:         Number of bytes to write.
 361 :returns:       True on success, false if maximum length is exceeded or an IO error happens.
 362
 363 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.
 364
 365 pb_encode
 366 ---------
 367 Encodes the contents of a structure as a protocol buffers message and writes it to output stream. ::
 368
 369     bool pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
 370
 371 :stream:        Output stream to write to.
 372 :fields:        A field description array, usually autogenerated.
 373 :src_struct:    Pointer to the data that will be serialized.
 374 :returns:       True on success, false on IO error, on detectable errors in field description, or if a field encoder returns false.
 375
 376 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.
 377
 378 .. sidebar:: Encoding fields manually
 379
 380     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.
 381
 382     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.
 383
 384     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.
 385
 386 pb_encode_tag
 387 -------------
 388 Starts a field in the Protocol Buffers binary format: encodes the field number and the wire type of the data. ::
 389
 390     bool pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, int field_number);
 391
 392 :stream:        Output stream to write to. 1-5 bytes will be written.
 393 :wiretype:      PB_WT_VARINT, PB_WT_64BIT, PB_WT_STRING or PB_WT_32BIT
 394 :field_number:  Identifier for the field, defined in the .proto file. You can get it from field->tag.
 395 :returns:       True on success, false on IO error.
 396
 397 pb_encode_tag_for_field
 398 -----------------------
 399 Same as `pb_encode_tag`_, except takes the parameters from a *pb_field_t* structure. ::
 400
 401     bool pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field);
 402
 403 :stream:        Output stream to write to. 1-5 bytes will be written.
 404 :field:         Field description structure. Usually autogenerated.
 405 :returns:       True on success, false on IO error or unknown field type.
 406
 407 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.
 408
 409 Wire type mapping is as follows:
 410
 411 ========================= ============
 412 LTYPEs                    Wire type
 413 ========================= ============
 414 VARINT, SVARINT           PB_WT_VARINT
 415 FIXED64                   PB_WT_64BIT
 416 STRING, BYTES, SUBMESSAGE PB_WT_STRING
 417 FIXED32                   PB_WT_32BIT
 418 ========================= ============
 419
 420 pb_encode_varint
 421 ----------------
 422 Encodes a signed or unsigned integer in the varint_ format. Works for fields of type `bool`, `enum`, `int32`, `int64`, `uint32` and `uint64`::
 423
 424     bool pb_encode_varint(pb_ostream_t *stream, uint64_t value);
 425
 426 :stream:        Output stream to write to. 1-10 bytes will be written.
 427 :value:         Value to encode. Just cast e.g. int32_t directly to uint64_t.
 428 :returns:       True on success, false on IO error.
 429
 430 .. _varint: http://code.google.com/apis/protocolbuffers/docs/encoding.html#varints
 431
 432 pb_encode_svarint
 433 -----------------
 434 Encodes a signed integer in the 'zig-zagged' format. Works for fields of type `sint32` and `sint64`::
 435
 436     bool pb_encode_svarint(pb_ostream_t *stream, int64_t value);
 437
 438 (parameters are the same as for `pb_encode_varint`_
 439
 440 pb_encode_string
 441 ----------------
 442 Writes the length of a string as varint and then contents of the string. Works for fields of type `bytes` and `string`::
 443
 444     bool pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size);
 445
 446 :stream:        Output stream to write to.
 447 :buffer:        Pointer to string data.
 448 :size:          Number of bytes in the string. Pass `strlen(s)` for strings.
 449 :returns:       True on success, false on IO error.
 450
 451 pb_encode_fixed32
 452 -----------------
 453 Writes 4 bytes to stream and swaps bytes on big-endian architectures. Works for fields of type `fixed32`, `sfixed32` and `float`::
 454
 455     bool pb_encode_fixed32(pb_ostream_t *stream, const void *value);
 456
 457 :stream:    Output stream to write to.
 458 :value:     Pointer to a 4-bytes large C variable, for example `uint32_t foo;`.
 459 :returns:   True on success, false on IO error.
 460
 461 pb_encode_fixed64
 462 -----------------
 463 Writes 8 bytes to stream and swaps bytes on big-endian architecture. Works for fields of type `fixed64`, `sfixed64` and `double`::
 464
 465     bool pb_encode_fixed64(pb_ostream_t *stream, const void *value);
 466
 467 :stream:    Output stream to write to.
 468 :value:     Pointer to a 8-bytes large C variable, for example `uint64_t foo;`.
 469 :returns:   True on success, false on IO error.
 470
 471 pb_encode_submessage
 472 --------------------
 473 Encodes a submessage field, including the size header for it. Works for fields of any message type::
 474
 475     bool pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
 476
 477 :stream:        Output stream to write to.
 478 :fields:        Pointer to the autogenerated field description array for the submessage type, e.g. `MyMessage_fields`.
 479 :src:           Pointer to the structure where submessage data is.
 480 :returns:       True on success, false on IO errors, pb_encode errors or if submessage size changes between calls.
 481
 482 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.
 483
 484 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.
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497 pb_decode.h
 498 ===========
 499
 500 pb_istream_from_buffer
 501 ----------------------
 502 Helper function for creating an input stream that reads data from a memory buffer. ::
 503
 504     pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize);
 505
 506 :buf:           Pointer to byte array to read from.
 507 :bufsize:       Size of the byte array.
 508 :returns:       An input stream ready to use.
 509
 510 pb_read
 511 -------
 512 Read data from input stream. Always use this function, don't try to call the stream callback directly. ::
 513
 514     bool pb_read(pb_istream_t *stream, uint8_t *buf, size_t count);
 515
 516 :stream:        Input stream to read from.
 517 :buf:           Buffer to store the data to, or NULL to just read data without storing it anywhere.
 518 :count:         Number of bytes to read.
 519 :returns:       True on success, false if *stream->bytes_left* is less than *count* or if an IO error occurs.
 520
 521 End of file is signalled by *stream->bytes_left* being zero after pb_read returns false.
 522
 523 pb_decode
 524 ---------
 525 Read and decode all fields of a structure. Reads until EOF on input stream. ::
 526
 527     bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
 528
 529 :stream:        Input stream to read from.
 530 :fields:        A field description array. Usually autogenerated.
 531 :dest_struct:   Pointer to structure where data will be stored.
 532 :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.
 533
 534 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.
 535
 536 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.
 537
 538 For optional fields, this function applies the default value and sets *has_<field>* to false if the field is not present.
 539
 540 pb_decode_noinit
 541 ----------------
 542 Same as `pb_decode`_, except does not apply the default values to fields. ::
 543
 544     bool pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
 545
 546 (parameters are the same as for `pb_decode`_.)
 547
 548 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.
 549
 550 pb_skip_varint
 551 --------------
 552 Skip a varint_ encoded integer without decoding it. ::
 553
 554     bool pb_skip_varint(pb_istream_t *stream);
 555
 556 :stream:        Input stream to read from. Will read 1 byte at a time until the MSB is clear.
 557 :returns:       True on success, false on IO error.
 558
 559 pb_skip_string
 560 --------------
 561 Skip a varint-length-prefixed string. This means skipping a value with wire type PB_WT_STRING. ::
 562
 563     bool pb_skip_string(pb_istream_t *stream);
 564
 565 :stream:        Input stream to read from.
 566 :returns:       True on success, false on IO error or length exceeding uint32_t.
 567
 568 pb_decode_tag
 569 -------------
 570 Decode the tag that comes before field in the protobuf encoding::
 571
 572     bool pb_decode_tag(pb_istream_t *stream, pb_wire_type_t *wire_type, int *tag, bool *eof);
 573
 574 :stream:        Input stream to read from.
 575 :wire_type:     Pointer to variable where to store the wire type of the field.
 576 :tag:           Pointer to variable where to store the tag of the field.
 577 :eof:           Pointer to variable where to store end-of-file status.
 578 :returns:       True on success, false on error or EOF.
 579
 580 When the message (stream) ends, this function will return false and set *eof* to true. On other
 581 errors, *eof* will be set to false.
 582
 583 pb_skip_field
 584 -------------
 585 Remove the data for a field from the stream, without actually decoding it::
 586
 587     bool pb_skip_field(pb_istream_t *stream, pb_wire_type_t wire_type);
 588
 589 :stream:        Input stream to read from.
 590 :wire_type:     Type of field to skip.
 591 :returns:       True on success, false on IO error.
 592
 593 .. sidebar:: Decoding fields manually
 594
 595     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.
 596
 597     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.
 598
 599     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`_.
 600
 601     Finally, for decoding submessages in a callback, simply use `pb_decode`_ and pass it the *SubMessage_fields* descriptor array.
 602
 603 pb_decode_varint
 604 ----------------
 605 Read and decode a varint_ encoded integer. ::
 606
 607     bool pb_decode_varint(pb_istream_t *stream, uint64_t *dest);
 608
 609 :stream:        Input stream to read from. 1-10 bytes will be read.
 610 :dest:          Storage for the decoded integer. Value is undefined on error.
 611 :returns:       True on success, false if value exceeds uint64_t range or an IO error happens.
 612
 613 pb_decode_svarint
 614 -----------------
 615 Similar to `pb_decode_varint`_, except that it performs zigzag-decoding on the value. This corresponds to the Protocol Buffers *sint32* and *sint64* datatypes. ::
 616
 617     bool pb_decode_svarint(pb_istream_t *stream, int64_t *dest);
 618
 619 (parameters are the same as `pb_decode_varint`_)
 620
 621 pb_decode_fixed32
 622 -----------------
 623 Decode a *fixed32*, *sfixed32* or *float* value. ::
 624
 625     bool pb_decode_fixed32(pb_istream_t *stream, void *dest);
 626
 627 :stream:        Input stream to read from. 4 bytes will be read.
 628 :dest:          Pointer to destination *int32_t*, *uint32_t* or *float*.
 629 :returns:       True on success, false on IO errors.
 630
 631 This function reads 4 bytes from the input stream.
 632 On big endian architectures, it then reverses the order of the bytes.
 633 Finally, it writes the bytes to *dest*.
 634
 635 pb_decode_fixed64
 636 -----------------
 637 Decode a *fixed64*, *sfixed64* or *double* value. ::
 638
 639     bool pb_dec_fixed(pb_istream_t *stream, const pb_field_t *field, void *dest);
 640
 641 :stream:        Input stream to read from. 8 bytes will be read.
 642 :field:         Not used.
 643 :dest:          Pointer to destination *int64_t*, *uint64_t* or *double*.
 644 :returns:       True on success, false on IO errors.
 645
 646 Same as `pb_decode_fixed32`_, except this reads 8 bytes.
 647
 648 pb_make_string_substream
 649 ------------------------
 650 Decode the length for a field with wire type *PB_WT_STRING* and create a substream for reading the data. ::
 651
 652     bool pb_make_string_substream(pb_istream_t *stream, pb_istream_t *substream);
 653
 654 :stream:        Original input stream to read the length and data from.
 655 :substream:     New substream that has limited length. Filled in by the function.
 656 :returns:       True on success, false if reading the length fails.
 657
 658 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.
 659
 660 pb_close_string_substream
 661 -------------------------
 662 Close the substream created with `pb_make_string_substream`_. ::
 663
 664     void pb_close_string_substream(pb_istream_t *stream, pb_istream_t *substream);
 665
 666 :stream:        Original input stream to read the length and data from.
 667 :substream:     Substream to close
 668
 669 This function copies back the state from the substream to the parent stream.
 670 It must be called after done with the substream.