added comments to subscriptionhandle

ros2-rust · Jun 26, 2024 · 0c2bb70 · 0c2bb70
1 parent 0ea5289
commit 0c2bb70
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/rclrs/src/subscription.rs b/rclrs/src/subscription.rs
@@ -36,6 +36,13 @@ pub struct SubscriptionHandle {
 }
 
 impl SubscriptionHandle {
+    /// Acquires the lock on the `rcl_subscription_t` and returns a mutable reference to it.
+    ///
+    /// # Safety
+    ///
+    /// This function is marked as unsafe because it returns a mutable reference to the
+    /// `rcl_subscription_t` struct, which could potentially be misused to violate safety
+    /// guarantees.
     pub(crate) fn lock(&self) -> MutexGuard<rcl_subscription_t> {
         self.rcl_subscription.lock().unwrap()
     }