Introduce BleDevice struct

It's better than a tuple

Author: lukipuki

src/connections/ble_handler.rs

@@ -86,6 +86,14 @@ impl Display for BleId {
     }
 }
 
+/// A Meshtastic device discovered via Bluetooth LE.
+pub struct BleDevice {
+    /// The broadcast name of the device.
+    pub name: Option<String>,
+    /// The MAC address of the device.
+    pub mac_address: BDAddr,
+}
+
 impl BleHandler {
     pub async fn new(ble_id: &BleId, scan_duration: Duration) -> Result<Self, Error> {
         let (radio, adapter) = Self::find_ble_radio(ble_id, scan_duration).await?;
@@ -155,16 +163,17 @@ impl BleHandler {
     /// Returns a list of all available Meshtastic BLE devices.
     ///
     /// This function scans for devices that expose the Meshtastic service UUID
-    /// (`6ba1b218-15a8-461f-9fa8-5dcae273eafd`) and returns a list of (name, MAC address) tuples
+    /// (`6ba1b218-15a8-461f-9fa8-5dcae273eafd`) and returns a list of [`BleDevice`]s
     /// that can be used to connect to them.
-    pub async fn available_ble_devices(
-        scan_duration: Duration,
-    ) -> Result<Vec<(Option<String>, BDAddr)>, Error> {
+    pub async fn available_ble_devices(scan_duration: Duration) -> Result<Vec<BleDevice>, Error> {
         let peripherals = Self::available_peripherals(scan_duration).await?;
         let mut devices = Vec::new();
         for (p, _) in &peripherals {
             if let Ok(Some(properties)) = p.properties().await {
-                devices.push((properties.local_name, properties.address));
+                devices.push(BleDevice {
+                    name: properties.local_name,
+                    mac_address: properties.address,
+                });
             }
         }
         Ok(devices)

src/utils_internal.rs

@@ -1,9 +1,7 @@
 #[cfg(feature = "bluetooth-le")]
-use crate::connections::ble_handler::BleHandler;
+use crate::connections::ble_handler::{BleDevice, BleHandler};
 use crate::errors_internal::Error;
 #[cfg(feature = "bluetooth-le")]
-use btleplug::api::BDAddr;
-#[cfg(feature = "bluetooth-le")]
 use futures::stream::StreamExt;
 use std::time::Duration;
 use std::time::UNIX_EPOCH;
@@ -214,23 +212,27 @@ pub async fn build_tcp_stream(
 ///
 /// # Returns
 ///
-/// A vector of Bluetooth devices identified by a MAC address and optionally also a name.
+/// A vector of [`BleDevice`]s, each identified by a MAC address and optionally also a name.
 ///
 /// # Examples
 ///
-/// ```
-/// let ble_devices = utils::available_ble_devices().await.unwrap();
-/// println!("Available Meshtastic BLE devices: {:?}", ble_devices);
-/// let stream = build_ble_stream(&ble_devices[0].1.into(), Duration::from_secs(10)).await;
+/// ```no_run
+/// use std::time::Duration;
+/// use meshtastic::utils;
+/// use meshtastic::BleId;
+///
+/// let ble_devices = utils::available_ble_devices(Duration::from_secs(5)).await?;
+/// if let Some(device) = ble_devices.first() {
+///     let stream = utils::build_ble_stream(&device.mac_address.into(), Duration::from_secs(10)).await;
+///     ...
+/// }
 /// ```
 ///
 /// # Errors
 ///
 /// Fails if the Blueetooth scan fails.
 #[cfg(feature = "bluetooth-le")]
-pub async fn available_ble_devices(
-    scan_duration: Duration,
-) -> Result<Vec<(Option<String>, BDAddr)>, Error> {
+pub async fn available_ble_devices(scan_duration: Duration) -> Result<Vec<BleDevice>, Error> {
     BleHandler::available_ble_devices(scan_duration).await
 }