diff --git a/docs/api.rst b/docs/api.rst index 5c224cf99..726c7127f 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1073,9 +1073,11 @@ See details at :ref:`owned_types_concept` .. c:function:: const z_loaned_hello_t * z_hello_loan(const z_owned_hello_t * hello) -Serialization (unstable) +Serialization ======================== +.. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. + Types ----- diff --git a/include/zenoh-pico/api/constants.h b/include/zenoh-pico/api/constants.h index d2c623e4c..027879f44 100644 --- a/include/zenoh-pico/api/constants.h +++ b/include/zenoh-pico/api/constants.h @@ -136,6 +136,8 @@ typedef enum { * Enumerators: * Z_RELIABILITY_BEST_EFFORT: Defines reliability as ``BEST_EFFORT`` * Z_RELIABILITY_RELIABLE: Defines reliability as ``RELIABLE`` + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ typedef enum { Z_RELIABILITY_BEST_EFFORT = 1, Z_RELIABILITY_RELIABLE = 0 } z_reliability_t; #define Z_RELIABILITY_DEFAULT Z_RELIABILITY_RELIABLE diff --git a/include/zenoh-pico/api/primitives.h b/include/zenoh-pico/api/primitives.h index 8daea5659..e29f41229 100644 --- a/include/zenoh-pico/api/primitives.h +++ b/include/zenoh-pico/api/primitives.h @@ -1413,6 +1413,8 @@ z_sample_kind_t z_sample_kind(const z_loaned_sample_t *sample); * * Return: * The reliability wrapped as a :c:type:`z_reliability_t`. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_reliability_t z_sample_reliability(const z_loaned_sample_t *sample); #endif @@ -2130,6 +2132,8 @@ z_result_t zp_send_join(const z_loaned_session_t *zs, const zp_send_join_options * * Return: * The reliability wrapped as a :c:type:`z_reliability_t`. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_reliability_t z_reliability_default(void); #endif diff --git a/include/zenoh-pico/api/serialization.h b/include/zenoh-pico/api/serialization.h index d79be3ad7..ca9142dfc 100644 --- a/include/zenoh-pico/api/serialization.h +++ b/include/zenoh-pico/api/serialization.h @@ -47,6 +47,8 @@ _Z_OWNED_TYPE_VALUE_PREFIX(ze, _ze_serializer_t, serializer) * * Return: * ``0`` in case of success, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_serializer_empty(ze_owned_serializer_t *serializer); @@ -57,6 +59,7 @@ z_result_t ze_serializer_empty(ze_owned_serializer_t *serializer); * serializer: A data serializer. * bytes: An uninitialized memory location where bytes is to be constructed. * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ void ze_serializer_finish(ze_moved_serializer_t *serializer, z_owned_bytes_t *bytes); @@ -70,6 +73,8 @@ void ze_serializer_finish(ze_moved_serializer_t *serializer, z_owned_bytes_t *by * * Return: * The constructed :c:type:`ze_deserializer_t`. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ ze_deserializer_t ze_deserializer_from_bytes(const z_loaned_bytes_t *bytes); @@ -81,6 +86,8 @@ ze_deserializer_t ze_deserializer_from_bytes(const z_loaned_bytes_t *bytes); * * Return: * ``True`` if there is no more data to parse, ``false`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ bool ze_deserializer_is_done(const ze_deserializer_t *deserializer); @@ -93,6 +100,8 @@ bool ze_deserializer_is_done(const ze_deserializer_t *deserializer); * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ static inline z_result_t ze_serializer_serialize_uint8(ze_loaned_serializer_t *serializer, uint8_t val) { return z_bytes_writer_write_all(&serializer->_writer, &val, 1); @@ -107,6 +116,8 @@ static inline z_result_t ze_serializer_serialize_uint8(ze_loaned_serializer_t *s * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ static inline z_result_t ze_serializer_serialize_uint16(ze_loaned_serializer_t *serializer, uint16_t val) { _z_host_le_store16(val, (uint8_t *)&val); @@ -122,6 +133,8 @@ static inline z_result_t ze_serializer_serialize_uint16(ze_loaned_serializer_t * * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ static inline z_result_t ze_serializer_serialize_uint32(ze_loaned_serializer_t *serializer, uint32_t val) { _z_host_le_store32(val, (uint8_t *)&val); @@ -137,6 +150,8 @@ static inline z_result_t ze_serializer_serialize_uint32(ze_loaned_serializer_t * * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ static inline z_result_t ze_serializer_serialize_uint64(ze_loaned_serializer_t *serializer, uint64_t val) { _z_host_le_store64(val, (uint8_t *)&val); @@ -152,6 +167,8 @@ static inline z_result_t ze_serializer_serialize_uint64(ze_loaned_serializer_t * * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ static inline z_result_t ze_serializer_serialize_float(ze_loaned_serializer_t *serializer, float val) { return z_bytes_writer_write_all(&serializer->_writer, (uint8_t *)&val, sizeof(val)); @@ -166,6 +183,8 @@ static inline z_result_t ze_serializer_serialize_float(ze_loaned_serializer_t *s * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ static inline z_result_t ze_serializer_serialize_double(ze_loaned_serializer_t *serializer, double val) { return z_bytes_writer_write_all(&serializer->_writer, (uint8_t *)&val, sizeof(val)); @@ -180,6 +199,8 @@ static inline z_result_t ze_serializer_serialize_double(ze_loaned_serializer_t * * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ static inline z_result_t ze_serializer_serialize_int8(ze_loaned_serializer_t *serializer, int8_t val) { return ze_serializer_serialize_uint8(serializer, (uint8_t)val); @@ -194,6 +215,8 @@ static inline z_result_t ze_serializer_serialize_int8(ze_loaned_serializer_t *se * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ static inline z_result_t ze_serializer_serialize_int16(ze_loaned_serializer_t *serializer, int16_t val) { return ze_serializer_serialize_uint16(serializer, (uint16_t)val); @@ -208,6 +231,8 @@ static inline z_result_t ze_serializer_serialize_int16(ze_loaned_serializer_t *s * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ static inline z_result_t ze_serializer_serialize_int32(ze_loaned_serializer_t *serializer, int32_t val) { return ze_serializer_serialize_uint32(serializer, (uint32_t)val); @@ -222,6 +247,8 @@ static inline z_result_t ze_serializer_serialize_int32(ze_loaned_serializer_t *s * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ static inline z_result_t ze_serializer_serialize_int64(ze_loaned_serializer_t *serializer, int64_t val) { return ze_serializer_serialize_uint64(serializer, (uint64_t)val); @@ -236,6 +263,8 @@ static inline z_result_t ze_serializer_serialize_int64(ze_loaned_serializer_t *s * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ static inline z_result_t ze_deserializer_deserialize_uint8(ze_deserializer_t *deserializer, uint8_t *val) { return z_bytes_reader_read(&deserializer->_reader, val, 1) == 1 ? _Z_RES_OK : _Z_ERR_DID_NOT_READ; @@ -250,6 +279,8 @@ static inline z_result_t ze_deserializer_deserialize_uint8(ze_deserializer_t *de * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ static inline z_result_t ze_deserializer_deserialize_uint16(ze_deserializer_t *deserializer, uint16_t *val) { if (z_bytes_reader_read(&deserializer->_reader, (uint8_t *)val, sizeof(uint16_t)) != sizeof(uint16_t)) { @@ -268,6 +299,8 @@ static inline z_result_t ze_deserializer_deserialize_uint16(ze_deserializer_t *d * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ static inline z_result_t ze_deserializer_deserialize_uint32(ze_deserializer_t *deserializer, uint32_t *val) { if (z_bytes_reader_read(&deserializer->_reader, (uint8_t *)val, sizeof(uint32_t)) != sizeof(uint32_t)) { @@ -286,6 +319,8 @@ static inline z_result_t ze_deserializer_deserialize_uint32(ze_deserializer_t *d * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ static inline z_result_t ze_deserializer_deserialize_uint64(ze_deserializer_t *deserializer, uint64_t *val) { if (z_bytes_reader_read(&deserializer->_reader, (uint8_t *)val, sizeof(uint64_t)) != sizeof(uint64_t)) { @@ -304,6 +339,8 @@ static inline z_result_t ze_deserializer_deserialize_uint64(ze_deserializer_t *d * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ static inline z_result_t ze_deserializer_deserialize_float(ze_deserializer_t *deserializer, float *val) { if (z_bytes_reader_read(&deserializer->_reader, (uint8_t *)val, sizeof(float)) != sizeof(float)) { @@ -321,6 +358,8 @@ static inline z_result_t ze_deserializer_deserialize_float(ze_deserializer_t *de * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ static inline z_result_t ze_deserializer_deserialize_double(ze_deserializer_t *deserializer, double *val) { if (z_bytes_reader_read(&deserializer->_reader, (uint8_t *)val, sizeof(double)) != sizeof(double)) { @@ -338,6 +377,8 @@ static inline z_result_t ze_deserializer_deserialize_double(ze_deserializer_t *d * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ static inline z_result_t ze_deserializer_deserialize_int8(ze_deserializer_t *deserializer, int8_t *val) { return ze_deserializer_deserialize_uint8(deserializer, (uint8_t *)val); @@ -352,6 +393,8 @@ static inline z_result_t ze_deserializer_deserialize_int8(ze_deserializer_t *des * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ static inline z_result_t ze_deserializer_deserialize_int16(ze_deserializer_t *deserializer, int16_t *val) { return ze_deserializer_deserialize_uint16(deserializer, (uint16_t *)val); @@ -366,6 +409,8 @@ static inline z_result_t ze_deserializer_deserialize_int16(ze_deserializer_t *de * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ static inline z_result_t ze_deserializer_deserialize_int32(ze_deserializer_t *deserializer, int32_t *val) { return ze_deserializer_deserialize_uint32(deserializer, (uint32_t *)val); @@ -380,6 +425,8 @@ static inline z_result_t ze_deserializer_deserialize_int32(ze_deserializer_t *de * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ static inline z_result_t ze_deserializer_deserialize_int64(ze_deserializer_t *deserializer, int64_t *val) { return ze_deserializer_deserialize_uint64(deserializer, (uint64_t *)val); @@ -395,6 +442,8 @@ static inline z_result_t ze_deserializer_deserialize_int64(ze_deserializer_t *de * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_serializer_serialize_buf(ze_loaned_serializer_t *serializer, const uint8_t *val, size_t len); @@ -408,6 +457,8 @@ z_result_t ze_serializer_serialize_buf(ze_loaned_serializer_t *serializer, const * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_serializer_serialize_slice(ze_loaned_serializer_t *serializer, const z_loaned_slice_t *val); @@ -420,6 +471,8 @@ z_result_t ze_serializer_serialize_slice(ze_loaned_serializer_t *serializer, con * * Return: * ``0`` if deserialization is successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_deserializer_deserialize_slice(ze_deserializer_t *deserializer, z_owned_slice_t *val); @@ -432,6 +485,8 @@ z_result_t ze_deserializer_deserialize_slice(ze_deserializer_t *deserializer, z_ * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_serializer_serialize_str(ze_loaned_serializer_t *serializer, const char *val); @@ -444,6 +499,8 @@ z_result_t ze_serializer_serialize_str(ze_loaned_serializer_t *serializer, const * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_serializer_serialize_string(ze_loaned_serializer_t *serializer, const z_loaned_string_t *val); @@ -456,6 +513,8 @@ z_result_t ze_serializer_serialize_string(ze_loaned_serializer_t *serializer, co * * Return: * ``0`` if deserialization is successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_deserializer_deserialize_string(ze_deserializer_t *deserializer, z_owned_string_t *val); @@ -469,6 +528,8 @@ z_result_t ze_deserializer_deserialize_string(ze_deserializer_t *deserializer, z * * Return: * ``0`` if deserialization is successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_serializer_serialize_sequence_length(ze_loaned_serializer_t *serializer, size_t len); @@ -482,6 +543,8 @@ z_result_t ze_serializer_serialize_sequence_length(ze_loaned_serializer_t *seria * * Return: * ``0`` if deserialization is successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_deserializer_deserialize_sequence_length(ze_deserializer_t *deserializer, size_t *len); @@ -495,6 +558,8 @@ z_result_t ze_deserializer_deserialize_sequence_length(ze_deserializer_t *deseri * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_serialize_buf(z_owned_bytes_t *bytes, const uint8_t *data, size_t len); @@ -507,6 +572,8 @@ z_result_t ze_serialize_buf(z_owned_bytes_t *bytes, const uint8_t *data, size_t * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_serialize_string(z_owned_bytes_t *bytes, const z_loaned_string_t *s); @@ -519,6 +586,8 @@ z_result_t ze_serialize_string(z_owned_bytes_t *bytes, const z_loaned_string_t * * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_serialize_str(z_owned_bytes_t *bytes, const char *value); @@ -531,6 +600,8 @@ z_result_t ze_serialize_str(z_owned_bytes_t *bytes, const char *value); * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_serialize_slice(z_owned_bytes_t *bytes, const z_loaned_slice_t *slice); @@ -543,6 +614,8 @@ z_result_t ze_serialize_slice(z_owned_bytes_t *bytes, const z_loaned_slice_t *sl * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_serialize_int8(z_owned_bytes_t *bytes, int8_t val); @@ -555,6 +628,8 @@ z_result_t ze_serialize_int8(z_owned_bytes_t *bytes, int8_t val); * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_serialize_int16(z_owned_bytes_t *bytes, int16_t val); @@ -567,6 +642,8 @@ z_result_t ze_serialize_int16(z_owned_bytes_t *bytes, int16_t val); * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_serialize_int32(z_owned_bytes_t *bytes, int32_t val); @@ -579,6 +656,8 @@ z_result_t ze_serialize_int32(z_owned_bytes_t *bytes, int32_t val); * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_serialize_int64(z_owned_bytes_t *bytes, int64_t val); @@ -591,6 +670,8 @@ z_result_t ze_serialize_int64(z_owned_bytes_t *bytes, int64_t val); * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_serialize_uint8(z_owned_bytes_t *bytes, uint8_t val); @@ -603,6 +684,8 @@ z_result_t ze_serialize_uint8(z_owned_bytes_t *bytes, uint8_t val); * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_serialize_uint16(z_owned_bytes_t *bytes, uint16_t val); @@ -615,6 +698,8 @@ z_result_t ze_serialize_uint16(z_owned_bytes_t *bytes, uint16_t val); * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_serialize_uint32(z_owned_bytes_t *bytes, uint32_t val); @@ -627,6 +712,8 @@ z_result_t ze_serialize_uint32(z_owned_bytes_t *bytes, uint32_t val); * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_serialize_uint64(z_owned_bytes_t *bytes, uint64_t val); @@ -639,6 +726,8 @@ z_result_t ze_serialize_uint64(z_owned_bytes_t *bytes, uint64_t val); * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_serialize_float(z_owned_bytes_t *bytes, float val); @@ -651,6 +740,8 @@ z_result_t ze_serialize_float(z_owned_bytes_t *bytes, float val); * * Return: * ``0`` if serialization is successful, ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_serialize_double(z_owned_bytes_t *bytes, double val); @@ -663,6 +754,8 @@ z_result_t ze_serialize_double(z_owned_bytes_t *bytes, double val); * * Return: * ``0`` if deserialization is successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_deserialize_slice(const z_loaned_bytes_t *bytes, z_owned_slice_t *dst); @@ -675,6 +768,8 @@ z_result_t ze_deserialize_slice(const z_loaned_bytes_t *bytes, z_owned_slice_t * * * Return: * ``0`` if deserialization is successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_deserialize_string(const z_loaned_bytes_t *bytes, z_owned_string_t *str); @@ -687,6 +782,8 @@ z_result_t ze_deserialize_string(const z_loaned_bytes_t *bytes, z_owned_string_t * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_deserialize_int8(const z_loaned_bytes_t *bytes, int8_t *dst); @@ -699,6 +796,8 @@ z_result_t ze_deserialize_int8(const z_loaned_bytes_t *bytes, int8_t *dst); * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_deserialize_int16(const z_loaned_bytes_t *bytes, int16_t *dst); @@ -711,6 +810,8 @@ z_result_t ze_deserialize_int16(const z_loaned_bytes_t *bytes, int16_t *dst); * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_deserialize_int32(const z_loaned_bytes_t *bytes, int32_t *dst); @@ -723,6 +824,8 @@ z_result_t ze_deserialize_int32(const z_loaned_bytes_t *bytes, int32_t *dst); * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_deserialize_int64(const z_loaned_bytes_t *bytes, int64_t *dst); @@ -735,6 +838,8 @@ z_result_t ze_deserialize_int64(const z_loaned_bytes_t *bytes, int64_t *dst); * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_deserialize_uint8(const z_loaned_bytes_t *bytes, uint8_t *dst); @@ -747,6 +852,8 @@ z_result_t ze_deserialize_uint8(const z_loaned_bytes_t *bytes, uint8_t *dst); * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_deserialize_uint16(const z_loaned_bytes_t *bytes, uint16_t *dst); @@ -759,6 +866,8 @@ z_result_t ze_deserialize_uint16(const z_loaned_bytes_t *bytes, uint16_t *dst); * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_deserialize_uint32(const z_loaned_bytes_t *bytes, uint32_t *dst); @@ -771,6 +880,8 @@ z_result_t ze_deserialize_uint32(const z_loaned_bytes_t *bytes, uint32_t *dst); * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_deserialize_uint64(const z_loaned_bytes_t *bytes, uint64_t *dst); @@ -783,6 +894,8 @@ z_result_t ze_deserialize_uint64(const z_loaned_bytes_t *bytes, uint64_t *dst); * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_deserialize_float(const z_loaned_bytes_t *bytes, float *dst); @@ -795,6 +908,8 @@ z_result_t ze_deserialize_float(const z_loaned_bytes_t *bytes, float *dst); * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. + * + * .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release. */ z_result_t ze_deserialize_double(const z_loaned_bytes_t *bytes, double *dst);