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