bt-hci 0.8.1

Bluetooth HCI data types
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

//! Blocking controller types and traits.
use crate::controller::ErrorType;
use crate::{data, ControllerToHostPacket, FromHciBytesError};

/// Trait representing a HCI controller which supports blocking and non-blocking operations.
pub trait Controller: ErrorType {
    /// Write ACL data to the controller. Blocks until done.
    fn write_acl_data(&self, packet: &data::AclPacket) -> Result<(), Self::Error>;

    /// Write Sync data to the controller. Blocks until done.
    fn write_sync_data(&self, packet: &data::SyncPacket) -> Result<(), Self::Error>;

    /// Write Iso data to the controller. Blocks until done.
    fn write_iso_data(&self, packet: &data::IsoPacket) -> Result<(), Self::Error>;

    /// Attempt to write ACL data to the controller.
    ///
    /// Returns a TryError if the operation would block.
    fn try_write_acl_data(&self, packet: &data::AclPacket) -> Result<(), TryError<Self::Error>>;

    /// Attempt to write Sync data to the controller.
    ///
    /// Returns a TryError if the operation would block.
    fn try_write_sync_data(&self, packet: &data::SyncPacket) -> Result<(), TryError<Self::Error>>;

    /// Attempt to write Iso data to the controller.
    ///
    /// Returns a TryError if the operation would block.
    fn try_write_iso_data(&self, packet: &data::IsoPacket) -> Result<(), TryError<Self::Error>>;

    /// Read a valid HCI packet from the controller. Blocks until done.
    fn read<'a>(&self, buf: &'a mut [u8]) -> Result<ControllerToHostPacket<'a>, Self::Error>;

    /// Read a valid HCI packet from the controller.
    ///
    /// Returns a TryError if the operation would block.
    fn try_read<'a>(&self, buf: &'a mut [u8]) -> Result<ControllerToHostPacket<'a>, TryError<Self::Error>>;
}

/// Error for representing an operation that blocks or fails
/// with an error.
#[derive(Debug)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum TryError<E> {
    /// Underlying controller error.
    Error(E),
    /// Operation would block.
    Busy,
}

impl<E: From<FromHciBytesError>> From<FromHciBytesError> for TryError<E> {
    fn from(value: FromHciBytesError) -> Self {
        TryError::Error(E::from(value))
    }
}