pb_encode.h

   1 /* pb_encode.h: Functions to encode protocol buffers. Depends on pb_encode.c.
   2  * The main function is pb_encode. You also need an output stream, and the
   3  * field descriptions created by nanopb_generator.py.
   4  */
   5
   6 #ifndef _PB_ENCODE_H_
   7 #define _PB_ENCODE_H_
   8
   9 #include "pb.h"
  10
  11 #ifdef __cplusplus
  12 extern "C" {
  13 #endif
  14
  15 /***************************
  16  * Main encoding functions *
  17  ***************************/
  18
  19 /* Encode a single protocol buffers message from C structure into a stream.
  20  * Returns true on success, false on any failure.
  21  * The actual struct pointed to by src_struct must match the description in fields.
  22  * All required fields in the struct are assumed to have been filled in.
  23  *
  24  * Example usage:
  25  *    MyMessage msg = {};
  26  *    uint8_t buffer[64];
  27  *    pb_ostream_t stream;
  28  *
  29  *    msg.field1 = 42;
  30  *    stream = pb_ostream_from_buffer(buffer, sizeof(buffer));
  31  *    pb_encode(&stream, MyMessage_fields, &msg);
  32  */
  33 bool pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
  34
  35 /* Same as pb_encode, but prepends the length of the message as a varint.
  36  * Corresponds to writeDelimitedTo() in Google's protobuf API.
  37  */
  38 bool pb_encode_delimited(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
  39
  40 /**************************************
  41  * Functions for manipulating streams *
  42  **************************************/
  43
  44 /* Create an output stream for writing into a memory buffer.
  45  * The number of bytes written can be found in stream.bytes_written after
  46  * encoding the message.
  47  *
  48  * Alternatively, you can use a custom stream that writes directly to e.g.
  49  * a file or a network socket.
  50  */
  51 pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize);
  52
  53 /* Pseudo-stream for measuring the size of a message without actually storing
  54  * the encoded data.
  55  *
  56  * Example usage:
  57  *    MyMessage msg = {};
  58  *    pb_ostream_t stream = PB_OSTREAM_SIZING;
  59  *    pb_encode(&stream, MyMessage_fields, &msg);
  60  *    printf("Message size is %d\n", stream.bytes_written);
  61  */
  62 #ifndef PB_NO_ERRMSG
  63 #define PB_OSTREAM_SIZING {0,0,0,0,0}
  64 #else
  65 #define PB_OSTREAM_SIZING {0,0,0,0}
  66 #endif
  67
  68 /* Function to write into a pb_ostream_t stream. You can use this if you need
  69  * to append or prepend some custom headers to the message.
  70  */
  71 bool pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count);
  72
  73 /* Structure for defining custom output streams. You will need to provide
  74  * a callback function to write the bytes to your storage, which can be
  75  * for example a file or a network socket.
  76  *
  77  * The callback must conform to these rules:
  78  *
  79  * 1) Return false on IO errors. This will cause encoding to abort.
  80  * 2) You can use state to store your own data (e.g. buffer pointer).
  81  * 3) pb_write will update bytes_written after your callback runs.
  82  * 4) Substreams will modify max_size and bytes_written. Don't use them
  83  *    to calculate any pointers.
  84  */
  85 struct _pb_ostream_t
  86 {
  87 #ifdef PB_BUFFER_ONLY
  88     /* Callback pointer is not used in buffer-only configuration.
  89      * Having an int pointer here allows binary compatibility but
  90      * gives an error if someone tries to assign callback function.
  91      * Also, NULL pointer marks a 'sizing stream' that does not
  92      * write anything.
  93      */
  94     int *callback;
  95 #else
  96     bool (*callback)(pb_ostream_t *stream, const uint8_t *buf, size_t count);
  97 #endif
  98     void *state;          /* Free field for use by callback implementation. */
  99     size_t max_size;      /* Limit number of output bytes written (or use SIZE_MAX). */
 100     size_t bytes_written; /* Number of bytes written so far. */
 101
 102 #ifndef PB_NO_ERRMSG
 103     const char *errmsg;
 104 #endif
 105 };
 106
 107
 108 /************************************************
 109  * Helper functions for writing field callbacks *
 110  ************************************************/
 111
 112 /* Encode field header based on type and field number defined in the field
 113  * structure. Call this from the callback before writing out field contents. */
 114 bool pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field);
 115
 116 /* Encode field header by manually specifing wire type. You need to use this
 117  * if you want to write out packed arrays from a callback field. */
 118 bool pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, uint32_t field_number);
 119
 120 /* Encode an integer in the varint format.
 121  * This works for bool, enum, int32, int64, uint32 and uint64 field types. */
 122 bool pb_encode_varint(pb_ostream_t *stream, uint64_t value);
 123
 124 /* Encode an integer in the zig-zagged svarint format.
 125  * This works for sint32 and sint64. */
 126 bool pb_encode_svarint(pb_ostream_t *stream, int64_t value);
 127
 128 /* Encode a string or bytes type field. For strings, pass strlen(s) as size. */
 129 bool pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size);
 130
 131 /* Encode a fixed32, sfixed32 or float value.
 132  * You need to pass a pointer to a 4-byte wide C variable. */
 133 bool pb_encode_fixed32(pb_ostream_t *stream, const void *value);
 134
 135 /* Encode a fixed64, sfixed64 or double value.
 136  * You need to pass a pointer to a 8-byte wide C variable. */
 137 bool pb_encode_fixed64(pb_ostream_t *stream, const void *value);
 138
 139 /* Encode a submessage field.
 140  * You need to pass the pb_field_t array and pointer to struct, just like
 141  * with pb_encode(). This internally encodes the submessage twice, first to
 142  * calculate message size and then to actually write it out.
 143  */
 144 bool pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
 145
 146
 147 /*******************************
 148  * Internal / legacy functions *
 149  *******************************/
 150
 151 #ifdef NANOPB_INTERNALS
 152 bool pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
 153 bool pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
 154 bool pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src);
 155 bool pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src);
 156 bool pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src);
 157 bool pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src);
 158 #endif
 159
 160 /* This function is not recommended for new programs. Use pb_encode_submessage()
 161  * instead, it has the same functionality with a less confusing interface. */
 162 bool pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src);
 163
 164 #ifdef __cplusplus
 165 } /* extern "C" */
 166 #endif
 167
 168 #endif