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