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