Add serialization

eclipse-zenoh · Oct 1, 2024 · 38a68e5 · 38a68e5
1 parent 09d4f64
commit 38a68e5
Showing 1 changed file with 79 additions and 0 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -1000,6 +1000,7 @@ Types
 -----
 
 Represents the reply to a query.
+See details at :ref:`owned_types_concept`
 
 .. c:type:: z_owned_reply_t
 .. c:type:: z_loaned_reply_t
@@ -1077,6 +1078,84 @@ See details at :ref:`owned_types_concept`
 .. c:function:: void z_hello_clone(z_owned_hello_t * dst, const z_loaned_hello_t * hello) 
 .. c:function:: const z_loaned_hello_t * z_hello_loan(const z_owned_hello_t * hello)
 
+
+Serialization (unstable)
+========================
+
+Types
+-----
+
+Represents a data serializer (unstable).
+See details at :ref:`owned_types_concept`
+
+.. c:type:: ze_owned_serializer_t
+.. c:type:: ze_loaned_serializer_t
+.. c:type:: ze_moved_serializer_t
+
+.. autoctype:: serialization.h::ze_deserializer_t
+
+Functions
+---------
+.. autocfunction:: serialization.h::ze_deserializer_from_bytes
+.. autocfunction:: serialization.h::ze_deserializer_deserialize_int8
+.. autocfunction:: serialization.h::ze_deserializer_deserialize_int16
+.. autocfunction:: serialization.h::ze_deserializer_deserialize_int32
+.. autocfunction:: serialization.h::ze_deserializer_deserialize_int64
+.. autocfunction:: serialization.h::ze_deserializer_deserialize_uint8
+.. autocfunction:: serialization.h::ze_deserializer_deserialize_uint16
+.. autocfunction:: serialization.h::ze_deserializer_deserialize_uint32
+.. autocfunction:: serialization.h::ze_deserializer_deserialize_uint64
+.. autocfunction:: serialization.h::ze_deserializer_deserialize_float
+.. autocfunction:: serialization.h::ze_deserializer_deserialize_double
+.. autocfunction:: serialization.h::ze_deserializer_deserialize_slice
+.. autocfunction:: serialization.h::ze_deserializer_deserialize_string
+.. autocfunction:: serialization.h::ze_deserializer_deserialize_sequence_length
+.. autocfunction:: serialization.h::ze_serializer_empty
+.. autocfunction:: serialization.h::ze_serializer_finish
+.. autocfunction:: serialization.h::ze_serializer_serialize_int8
+.. autocfunction:: serialization.h::ze_serializer_serialize_int16
+.. autocfunction:: serialization.h::ze_serializer_serialize_int32
+.. autocfunction:: serialization.h::ze_serializer_serialize_int64
+.. autocfunction:: serialization.h::ze_serializer_serialize_uint8
+.. autocfunction:: serialization.h::ze_serializer_serialize_uint16
+.. autocfunction:: serialization.h::ze_serializer_serialize_uint32
+.. autocfunction:: serialization.h::ze_serializer_serialize_uint64
+.. autocfunction:: serialization.h::ze_serializer_serialize_float
+.. autocfunction:: serialization.h::ze_serializer_serialize_double
+.. autocfunction:: serialization.h::ze_serializer_serialize_slice
+.. autocfunction:: serialization.h::ze_serializer_serialize_buf
+.. autocfunction:: serialization.h::ze_serializer_serialize_string
+.. autocfunction:: serialization.h::ze_serializer_serialize_str
+.. autocfunction:: serialization.h::ze_serializer_serialize_sequence_length
+.. autocfunction:: serialization.h::ze_deserialize_int8
+.. autocfunction:: serialization.h::ze_deserialize_int16
+.. autocfunction:: serialization.h::ze_deserialize_int32
+.. autocfunction:: serialization.h::ze_deserialize_int64
+.. autocfunction:: serialization.h::ze_deserialize_uint8
+.. autocfunction:: serialization.h::ze_deserialize_uint16
+.. autocfunction:: serialization.h::ze_deserialize_uint32
+.. autocfunction:: serialization.h::ze_deserialize_uint64
+.. autocfunction:: serialization.h::ze_deserialize_float
+.. autocfunction:: serialization.h::ze_deserialize_double
+.. autocfunction:: serialization.h::ze_deserialize_slice
+.. autocfunction:: serialization.h::ze_deserialize_string
+.. autocfunction:: serialization.h::ze_deserializer_is_done
+.. autocfunction:: serialization.h::ze_serialize_int8
+.. autocfunction:: serialization.h::ze_serialize_int16
+.. autocfunction:: serialization.h::ze_serialize_int32
+.. autocfunction:: serialization.h::ze_serialize_int64
+.. autocfunction:: serialization.h::ze_serialize_uint8
+.. autocfunction:: serialization.h::ze_serialize_uint16
+.. autocfunction:: serialization.h::ze_serialize_uint32
+.. autocfunction:: serialization.h::ze_serialize_uint64
+.. autocfunction:: serialization.h::ze_serialize_float
+.. autocfunction:: serialization.h::ze_serialize_double
+.. autocfunction:: serialization.h::ze_serialize_slice
+.. autocfunction:: serialization.h::ze_serialize_buf
+.. autocfunction:: serialization.h::ze_serialize_string
+.. autocfunction:: serialization.h::ze_serialize_str
+
+
 Others
 ======