Merge pull request #682 from DenisBiryukov91/writer-docs

update docs regarding undefined behavior when using multiple z_bytes_writers
eclipse-zenoh · Sep 13, 2024 · 20580b8 · 20580b8
2 parents c453da5 + d9d17c2
commit 20580b8
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/include/zenoh_commons.h b/include/zenoh_commons.h
@@ -1610,7 +1610,8 @@ ZENOHC_API struct z_bytes_reader_t z_bytes_get_reader(const struct z_loaned_byte
 ZENOHC_API
 struct z_bytes_slice_iterator_t z_bytes_get_slice_iterator(const struct z_loaned_bytes_t *this_);
 /**
- * Gets writer for `this_`.
+ * @brief Gets writer for`this_`.
+ * @note Creating another writer while previous one is still in use is undefined behaviour.
  */
 ZENOHC_API struct z_bytes_writer_t z_bytes_get_writer(struct z_loaned_bytes_t *this_);
 /**

diff --git a/src/payload.rs b/src/payload.rs
@@ -945,7 +945,8 @@ pub use crate::opaque_types::z_bytes_writer_t;
 
 decl_c_type! {loaned(z_bytes_writer_t, ZBytesWriter<'static>)}
 
-/// Gets writer for `this_`.
+/// @brief Gets writer for`this_`.
+/// @note Creating another writer while previous one is still in use is undefined behaviour.
 #[no_mangle]
 extern "C" fn z_bytes_get_writer(this: &'static mut z_loaned_bytes_t) -> z_bytes_writer_t {
     *this.as_rust_type_mut().writer().as_loaned_c_type_ref()