4 /* pb_decode.h: Functions to decode protocol buffers. Depends on pb_decode.c.
5 * The main function is pb_decode. You will also need to create an input
6 * stream, which is easiest to do with pb_istream_from_buffer().
8 * You also need structures and their corresponding pb_field_t descriptions.
9 * These are usually generated from .proto-files with a script.
18 /* Lightweight input stream.
19 * You can provide a callback function for reading or use
20 * pb_istream_from_buffer.
23 * 1) Return false on IO errors. This will cause decoding to abort.
25 * 2) You can use state to store your own data (e.g. buffer pointer),
26 * and rely on pb_read to verify that no-body reads past bytes_left.
28 * 3) Your callback may be used with substreams, in which case bytes_left
29 * is different than from the main stream. Don't use bytes_left to compute
35 /* Callback pointer is not used in buffer-only configuration.
36 * Having an int pointer here allows binary compatibility but
37 * gives an error if someone tries to assign callback function.
41 bool (*callback)(pb_istream_t *stream, uint8_t *buf, size_t count);
44 void *state; /* Free field for use by callback implementation */
52 pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize);
53 bool pb_read(pb_istream_t *stream, uint8_t *buf, size_t count);
55 /* Decode from stream to destination struct.
56 * Returns true on success, false on any failure.
57 * The actual struct pointed to by dest must match the description in fields.
59 bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
61 /* Same as pb_decode, except does not initialize the destination structure
62 * to default values. This is slightly faster if you need no default values
63 * and just do memset(struct, 0, sizeof(struct)) yourself.
65 bool pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
67 /* --- Helper functions ---
68 * You may want to use these from your caller or callbacks.
71 /* Decode the tag for the next field in the stream. Gives the wire type and
72 * field tag. At end of the message, returns false and sets eof to true. */
73 bool pb_decode_tag(pb_istream_t *stream, pb_wire_type_t *wire_type, uint32_t *tag, bool *eof);
75 /* Skip the field payload data, given the wire type. */
76 bool pb_skip_field(pb_istream_t *stream, pb_wire_type_t wire_type);
78 /* Decode an integer in the varint format. This works for bool, enum, int32,
79 * int64, uint32 and uint64 field types. */
80 bool pb_decode_varint(pb_istream_t *stream, uint64_t *dest);
82 /* Decode an integer in the zig-zagged svarint format. This works for sint32
84 bool pb_decode_svarint(pb_istream_t *stream, int64_t *dest);
86 /* Decode a fixed32, sfixed32 or float value. You need to pass a pointer to
87 * a 4-byte wide C variable. */
88 bool pb_decode_fixed32(pb_istream_t *stream, void *dest);
90 /* Decode a fixed64, sfixed64 or double value. You need to pass a pointer to
91 * a 8-byte wide C variable. */
92 bool pb_decode_fixed64(pb_istream_t *stream, void *dest);
94 /* Make a limited-length substream for reading a PB_WT_STRING field. */
95 bool pb_make_string_substream(pb_istream_t *stream, pb_istream_t *substream);
96 void pb_close_string_substream(pb_istream_t *stream, pb_istream_t *substream);
98 /* --- Internal functions ---
99 * These functions are not terribly useful for the average library user, but
100 * are exported to make the unit testing and extending nanopb easier.
103 #ifdef NANOPB_INTERNALS
104 bool pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest);
105 bool pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, void *dest);
106 bool pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest);
107 bool pb_dec_fixed64(pb_istream_t *stream, const pb_field_t *field, void *dest);
109 bool pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest);
110 bool pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest);
111 bool pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field, void *dest);
113 bool pb_skip_varint(pb_istream_t *stream);
114 bool pb_skip_string(pb_istream_t *stream);