Fix shm api reexports (#2003)

* Export WithProtocolID

* Update types.rs, lib.rs, and lib.rs

* Remove ProtocolID from client storage

* Change safety doc format

Author: yellowhatter

commons/zenoh-shm/src/api/client_storage/mod.rs

@@ -46,22 +46,19 @@ pub struct ShmClientSetBuilder;
 impl ShmClientSetBuilder {
     /// Add client to the storage (without including the default client set)
     #[zenoh_macros::unstable_doc]
-    pub fn with_client(
-        self,
-        id: ProtocolID,
-        client: Arc<dyn ShmClient>,
-    ) -> ShmClientStorageBuilder {
-        let clients = BTreeMap::from([(id, client)]);
+    pub fn with_client(self, client: Arc<dyn ShmClient>) -> ShmClientStorageBuilder {
+        let clients = BTreeMap::from([(client.id(), client)]);
         ShmClientStorageBuilder::new(clients)
     }
 
     /// Add list of clients to the storage (without including the default client set)
     #[zenoh_macros::unstable_doc]
-    pub fn with_clients(
-        self,
-        clients: &[(ProtocolID, Arc<dyn ShmClient>)],
-    ) -> ShmClientStorageBuilder {
-        let clients = clients.iter().cloned().collect();
+    pub fn with_clients(self, clients: &[Arc<dyn ShmClient>]) -> ShmClientStorageBuilder {
+        let clients = clients
+            .iter()
+            .cloned()
+            .map(|client| (client.id(), client))
+            .collect();
         ShmClientStorageBuilder::new(clients)
     }
 
@@ -86,7 +83,8 @@ impl ShmClientStorageBuilder {
 
     /// Add client to the storage
     #[zenoh_macros::unstable_doc]
-    pub fn with_client(mut self, id: ProtocolID, client: Arc<dyn ShmClient>) -> ZResult<Self> {
+    pub fn with_client(mut self, client: Arc<dyn ShmClient>) -> ZResult<Self> {
+        let id = client.id();
         match self.clients.entry(id) {
             std::collections::btree_map::Entry::Occupied(occupied) => {
                 bail!("Client already exists for id {id}: {:?}!", occupied)
@@ -100,8 +98,9 @@ impl ShmClientStorageBuilder {
 
     /// Add list of clients to the storage
     #[zenoh_macros::unstable_doc]
-    pub fn with_clients(mut self, clients: &[(ProtocolID, Arc<dyn ShmClient>)]) -> Self {
-        self.clients.extend(clients.iter().cloned());
+    pub fn with_clients(mut self, clients: &[Arc<dyn ShmClient>]) -> Self {
+        self.clients
+            .extend(clients.iter().cloned().map(|client| (client.id(), client)));
         self
     }
 

commons/zenoh-shm/src/api/common/types.rs

@@ -45,7 +45,10 @@ impl PtrInSegment {
         self.ptr
     }
 
-    pub fn ptr_mut(&mut self) -> *mut u8 {
+    /// # SAFETY
+    ///
+    /// This function is safe if there is guarantee that there is no concurrent access
+    pub unsafe fn ptr_mut(&mut self) -> *mut u8 {
         self.ptr
     }
 }

commons/zenoh-shm/src/lib.rs

@@ -71,7 +71,7 @@ tested_crate_module!(shm);
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub struct ShmBufInfo {
     /// Actual data length
-    /// NOTE: data_descriptor's len is >= of this len and describes the actual memory length
+    /// NOTE: data descriptor's len is >= of this len and describes the actual memory length
     /// dedicated in shared memory segment for this particular buffer.
     pub data_len: NonZeroUsize,
 

zenoh/src/lib.rs

@@ -542,7 +542,10 @@ pub mod shm {
         cleanup::cleanup_orphaned_shm_segments,
         client::{shm_client::ShmClient, shm_segment::ShmSegment},
         client_storage::{ShmClientStorage, GLOBAL_CLIENT_STORAGE},
-        common::types::{ChunkID, ProtocolID, SegmentID},
+        common::{
+            types::{ChunkID, ProtocolID, PtrInSegment, SegmentID},
+            with_id::WithProtocolID,
+        },
         protocol_implementations::posix::{
             posix_shm_client::PosixShmClient,
             posix_shm_provider_backend::{