leaprs 0.2.2

Safe wrapper for the LeapC Ultraleap (Leap Motion) hand tracking device API.
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

use leap_sys::LEAP_DEVICE_INFO;
use num_enum::FromPrimitive;
use std::{ffi::CStr, ops::Deref};

use crate::{Capabilities, DevicePID, DeviceStatus};

#[doc = " Properties of a Leap device."]
#[doc = " Get a LEAP_DEVICE_INFO by calling LeapGetDeviceInfo() with the handle for"]
#[doc = " device. The device must be open."]
#[doc = " @since 3.0.0"]
/// # Fields
/// Available via dereference: [LEAP_DEVICE_INFO].
pub struct DeviceInfo {
    handle: LEAP_DEVICE_INFO,
    #[allow(dead_code)] // handle contains a pointer to serial
    serial: Vec<i8>,
}

impl DeviceInfo {
    pub(crate) fn new(handle: LEAP_DEVICE_INFO, serial: Vec<i8>) -> Self {
        Self { handle, serial }
    }

    #[doc = " A combination of eLeapDeviceStatus flags. @since 3.0.0"]
    pub fn status(&self) -> DeviceStatus {
        DeviceStatus::from_bits_truncate(self.handle.status)
    }

    pub fn caps(&self) -> Capabilities {
        Capabilities::from_bits_truncate(self.handle.caps)
    }

    #[doc = " One of the eLeapDevicePID members. @since 3.0.0"]
    pub fn pid(&self) -> DevicePID {
        DevicePID::from_primitive(self.handle.pid)
    }

    #[doc = " A pointer to the null-terminated device serial number string. @since 3.0.0"]
    pub fn serial(&self) -> Option<&str> {
        let serial = unsafe { CStr::from_ptr(self.handle.serial) };
        serial.to_str().ok()
    }
}

impl Deref for DeviceInfo {
    type Target = LEAP_DEVICE_INFO;

    fn deref(&self) -> &Self::Target {
        &self.handle
    }
}

#[cfg(test)]
mod tests {
    use crate::tests::*;
    use crate::*;

    #[test]
    fn get_device_info() {
        let mut connection = initialize_connection();
        let devices = connection
            .get_device_list()
            .expect("Failed to list devices");
        let device_info = devices.first().expect("No devices plugged for tests.");
        let mut device = device_info.open().expect("Failed to open the device");
        let device_info = device.get_info().expect("Failed to get device info");
        assert_ne!(device_info.pid(), DevicePID::Unknown);
        let serial = device_info.serial().expect("Failed to get serial");
        assert!(!serial.is_empty());
        let _status = device_info.status();
        let _caps = device_info.caps();
    }
}