Add #[must_use] to handle types.

bluez · Jun 26, 2024 · 9c01bef · 9c01bef
1 parent b2318c6
commit 9c01bef
Show file tree

Hide file tree

Showing 5 changed files with 4 additions and 1 deletion.
diff --git a/bluer/src/adapter.rs b/bluer/src/adapter.rs
@@ -14,7 +14,6 @@ use std::{
     collections::{BTreeSet, HashMap, HashSet},
     fmt::{Debug, Formatter},
     sync::Arc,
-    u32,
 };
 use strum::{Display, EnumString};
 use tokio::sync::mpsc;

diff --git a/bluer/src/adv.rs b/bluer/src/adv.rs
@@ -330,6 +330,7 @@ impl Advertisement {
 /// Handle to active Bluetooth LE advertisement.
 ///
 /// Drop to unregister advertisement.
+#[must_use = "AdvertisementHandle must be held for advertisement to be broadcasted"]
 pub struct AdvertisementHandle {
     name: dbus::Path<'static>,
     _drop_tx: oneshot::Sender<()>,

diff --git a/bluer/src/agent.rs b/bluer/src/agent.rs
@@ -496,6 +496,7 @@ impl RegisteredAgent {
 /// Handle to registered agent.
 ///
 /// Drop to unregister agent.
+#[must_use = "AgentHandle must be held for agent to be registered"]
 pub struct AgentHandle {
     name: dbus::Path<'static>,
     _drop_tx: oneshot::Sender<()>,

diff --git a/bluer/src/gatt/local.rs b/bluer/src/gatt/local.rs
@@ -1463,6 +1463,7 @@ impl Profile {
 /// Handle to published local profile (GATT client) instance.
 ///
 /// Drop this handle to unpublish.
+#[must_use = "ProfileHandle must be held for profile to be published"]
 pub struct ProfileHandle {
     name: dbus::Path<'static>,
     _drop_tx: oneshot::Sender<()>,

diff --git a/bluer/src/mesh/application.rs b/bluer/src/mesh/application.rs
@@ -237,6 +237,7 @@ pub(crate) struct ApplicationInner {
 /// Handle to Bluetooth mesh application.
 ///
 /// Drop this handle to unpublish.
+#[must_use = "ApplicationHandle must be held for mesh application to be published"]
 pub struct ApplicationHandle {
     pub(crate) app_inner: Arc<ApplicationInner>,
     pub(crate) name: dbus::Path<'static>,