feat: add Adapter retrieve_peripherals method

Author: szymonlesisz

src/api/mod.rs

@@ -209,6 +209,15 @@ pub struct ScanFilter {
     pub services: Vec<Uuid>,
 }
 
+/// Parameters of retrieve_peripherals method.
+#[derive(Clone, Debug, Eq, PartialEq)]
+pub struct RetrievePeripheralsOptions {
+    /// retrieve connected peripherals by services
+    services: Option<Vec<Uuid>>,
+    /// retrieve known peripherals by identifiers
+    identifiers: Option<Vec<PeripheralId>>,
+}
+
 /// The type of write operation to use.
 #[derive(Clone, Copy, Debug, Eq, PartialEq)]
 pub enum WriteType {
@@ -363,6 +372,12 @@ pub trait Central: Send + Sync + Clone {
     /// may contain peripherals that are no longer available.
     async fn peripherals(&self) -> Result<Vec<Self::Peripheral>>;
 
+    /// Returns the list of known or connected [`Peripheral`]s
+    async fn retrieve_peripherals(
+        &self,
+        options: RetrievePeripheralsOptions,
+    ) -> Result<Vec<Self::Peripheral>>;
+
     /// Returns a particular [`Peripheral`] by its address if it has been discovered.
     async fn peripheral(&self, id: &PeripheralId) -> Result<Self::Peripheral>;
 

src/bluez/adapter.rs

@@ -1,5 +1,5 @@
 use super::peripheral::{Peripheral, PeripheralId};
-use crate::api::{Central, CentralEvent, CentralState, ScanFilter};
+use crate::api::{Central, CentralEvent, CentralState, RetrievePeripheralsOptions, ScanFilter};
 use crate::{Error, Result};
 use async_trait::async_trait;
 use bluez_async::{
@@ -91,6 +91,13 @@ impl Central for Adapter {
             .collect())
     }
 
+    async fn retrieve_peripherals(
+        &self,
+        options: RetrievePeripheralsOptions,
+    ) -> Result<Vec<Peripheral>> {
+        Err(Error::NotSupported("Not implemented".to_string()))
+    }
+
     async fn peripheral(&self, id: &PeripheralId) -> Result<Peripheral> {
         let device = self.session.get_device_info(&id.0).await.map_err(|e| {
             if let BluetoothError::DbusError(_) = e {

src/corebluetooth/adapter.rs

@@ -3,7 +3,7 @@ use super::internal::{
     CoreBluetoothReplyFuture,
 };
 use super::peripheral::{Peripheral, PeripheralId};
-use crate::api::{Central, CentralEvent, CentralState, ScanFilter};
+use crate::api::{Central, CentralEvent, CentralState, RetrievePeripheralsOptions, ScanFilter};
 use crate::common::adapter_manager::AdapterManager;
 use crate::{Error, Result};
 use async_trait::async_trait;
@@ -122,6 +122,13 @@ impl Central for Adapter {
         Ok(self.manager.peripherals())
     }
 
+    async fn retrieve_peripherals(
+        &self,
+        options: RetrievePeripheralsOptions,
+    ) -> Result<Vec<Peripheral>> {
+        Err(Error::NotSupported("Not implemented".to_string()))
+    }
+
     async fn peripheral(&self, id: &PeripheralId) -> Result<Peripheral> {
         self.manager.peripheral(id).ok_or(Error::DeviceNotFound)
     }

src/droidplug/adapter.rs

@@ -6,7 +6,10 @@ use super::{
     peripheral::{Peripheral, PeripheralId},
 };
 use crate::{
-    api::{BDAddr, Central, CentralEvent, CentralState, PeripheralProperties, ScanFilter},
+    api::{
+        BDAddr, Central, CentralEvent, CentralState, PeripheralProperties,
+        RetrievePeripheralsOptions, ScanFilter,
+    },
     common::adapter_manager::AdapterManager,
     Error, Result,
 };
@@ -158,6 +161,13 @@ impl Central for Adapter {
         Ok(self.manager.peripherals())
     }
 
+    async fn retrieve_peripherals(
+        &self,
+        options: RetrievePeripheralsOptions,
+    ) -> Result<Vec<Peripheral>> {
+        Err(Error::NotSupported("Not implemented".to_string()))
+    }
+
     async fn peripheral(&self, address: &PeripheralId) -> Result<Peripheral> {
         self.manager
             .peripheral(address)

src/winrtble/adapter.rs

@@ -13,7 +13,7 @@
 
 use super::{ble::watcher::BLEWatcher, peripheral::Peripheral, peripheral::PeripheralId};
 use crate::{
-    api::{BDAddr, Central, CentralEvent, CentralState, ScanFilter},
+    api::{BDAddr, Central, CentralEvent, CentralState, RetrievePeripheralsOptions, ScanFilter},
     common::adapter_manager::AdapterManager,
     Error, Result,
 };
@@ -118,6 +118,13 @@ impl Central for Adapter {
         Ok(self.manager.peripherals())
     }
 
+    async fn retrieve_peripherals(
+        &self,
+        options: RetrievePeripheralsOptions,
+    ) -> Result<Vec<Peripheral>> {
+        Err(Error::NotSupported("Not implemented".to_string()))
+    }
+
     async fn peripheral(&self, id: &PeripheralId) -> Result<Peripheral> {
         self.manager.peripheral(id).ok_or(Error::DeviceNotFound)
     }