iohidmanager 0.8.0

Safe Rust bindings for Apple's IOKit HID — enumerate, inspect, and subscribe to HID devices on macOS
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

use crate::{bridge, ffi_impl as ffi};

pub type IOHIDAccelerationAlgorithmType = ffi::IOHIDAccelerationAlgorithmType;
pub type IOHIDKeyboardPhysicalLayoutType = ffi::IOHIDKeyboardPhysicalLayoutType;
pub type IOHIDOptionsType = ffi::IOHIDOptionsType;
pub type IOHIDStandardType = ffi::IOHIDStandardType;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct KeyDefinition {
    pub symbol: &'static str,
    pub value: &'static str,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct NumericDefinition {
    pub symbol: &'static str,
    pub value: u64,
}

pub const DEVICE_KEY: &str = "IOHIDDevice";
pub const TRANSPORT_KEY: &str = "Transport";
pub const VENDOR_ID_KEY: &str = "VendorID";
pub const PRODUCT_ID_KEY: &str = "ProductID";
pub const PRODUCT_KEY: &str = "Product";
pub const MANUFACTURER_KEY: &str = "Manufacturer";
pub const SERIAL_NUMBER_KEY: &str = "SerialNumber";
pub const DEVICE_USAGE_PAIRS_KEY: &str = "DeviceUsagePairs";
pub const DEVICE_USAGE_PAGE_KEY: &str = "DeviceUsagePage";
pub const DEVICE_USAGE_KEY: &str = "DeviceUsage";
pub const PRIMARY_USAGE_PAGE_KEY: &str = "PrimaryUsagePage";
pub const PRIMARY_USAGE_KEY: &str = "PrimaryUsage";
pub const REPORT_DESCRIPTOR_KEY: &str = "ReportDescriptor";
pub const ELEMENT_USAGE_PAGE_KEY: &str = "UsagePage";
pub const ELEMENT_USAGE_KEY: &str = "Usage";
pub const ELEMENT_REPORT_ID_KEY: &str = "ReportID";
pub const ELEMENT_COOKIE_MIN_KEY: &str = "ElementCookieMin";
pub const ELEMENT_COOKIE_MAX_KEY: &str = "ElementCookieMax";
pub const ELEMENT_USAGE_MIN_KEY: &str = "UsageMin";
pub const ELEMENT_USAGE_MAX_KEY: &str = "UsageMax";
pub const ELEMENT_VENDOR_SPECIFIC_KEY: &str = "VendorSpecific";
pub const TRANSPORT_USB_VALUE: &str = "USB";
pub const TRANSPORT_BLUETOOTH_VALUE: &str = "Bluetooth";
pub const DEVICE_SUSPEND_KEY: &str = "IOHIDDeviceSuspend";
pub const MAX_REPORT_BUFFER_COUNT_KEY: &str = "MaxReportBufferCount";
pub const REPORT_BUFFER_ENTRY_SIZE_KEY: &str = "ReportBufferEntrySize";
pub const KEYBOARD_LAYOUT_VALUE_KEY: &str = "HIDKeyboardLayoutValue";
pub const POINTER_ACCELERATION_ALGORITHM_KEY: &str = "HIDPointerAccelerationAlgorithm";
pub const SCROLL_ACCELERATION_ALGORITHM_KEY: &str = "HIDScrollAccelerationAlgorithm";
pub const SYSTEM_BUTTON_PRESSED_DURING_DARK_BOOT: u64 = 3_758_325_767;

pub const OPTIONS_TYPE_NONE: IOHIDOptionsType = ffi::kIOHIDOptionsTypeNone;
pub const OPTIONS_TYPE_SEIZE_DEVICE: IOHIDOptionsType = ffi::kIOHIDOptionsTypeSeizeDevice;
pub const OPTIONS_TYPE_MASK_PRIVATE: IOHIDOptionsType = 0x00ff_0000;
pub const QUEUE_OPTIONS_TYPE_NONE: IOHIDOptionsType = ffi::kIOHIDQueueOptionsTypeNone;
pub const QUEUE_OPTIONS_TYPE_ENQUEUE_ALL: IOHIDOptionsType = ffi::kIOHIDQueueOptionsTypeEnqueueAll;
pub const STANDARD_TYPE_ANSI: IOHIDStandardType = 0x0;
pub const STANDARD_TYPE_ISO: IOHIDStandardType = 0x1;
pub const STANDARD_TYPE_JIS: IOHIDStandardType = 0x2;
pub const STANDARD_TYPE_UNSPECIFIED: IOHIDStandardType = 0xffff_ffff;
pub const KEYBOARD_LAYOUT_TYPE_UNKNOWN: IOHIDKeyboardPhysicalLayoutType = 0x0;
pub const KEYBOARD_LAYOUT_TYPE_101: IOHIDKeyboardPhysicalLayoutType = 0x1;
pub const KEYBOARD_LAYOUT_TYPE_103: IOHIDKeyboardPhysicalLayoutType = 0x2;
pub const KEYBOARD_LAYOUT_TYPE_102: IOHIDKeyboardPhysicalLayoutType = 0x3;
pub const KEYBOARD_LAYOUT_TYPE_104: IOHIDKeyboardPhysicalLayoutType = 0x4;
pub const KEYBOARD_LAYOUT_TYPE_106: IOHIDKeyboardPhysicalLayoutType = 0x5;
pub const KEYBOARD_LAYOUT_TYPE_VENDOR: IOHIDKeyboardPhysicalLayoutType = 0x6;
pub const ACCELERATION_ALGORITHM_TABLE: IOHIDAccelerationAlgorithmType = 0;
pub const ACCELERATION_ALGORITHM_PARAMETRIC: IOHIDAccelerationAlgorithmType = 1;
pub const ACCELERATION_ALGORITHM_DEFAULT: IOHIDAccelerationAlgorithmType = 2;

include!("generated_keys.rs");

#[must_use]
pub fn string_key(symbol: &str) -> Option<&'static str> {
    ALL_STRING_KEYS
        .iter()
        .find(|definition| definition.symbol == symbol)
        .map(|definition| definition.value)
}

#[must_use]
pub fn numeric_constant(symbol: &str) -> Option<u64> {
    ALL_NUMERIC_CONSTANTS
        .iter()
        .find(|definition| definition.symbol == symbol)
        .map(|definition| definition.value)
}

#[must_use]
pub fn bridge_queue_enqueue_all() -> u32 {
    unsafe { bridge::iohidmanager_swift_keys_queue_enqueue_all() }
}

#[must_use]
pub fn bridge_standard_type_ansi() -> u32 {
    unsafe { bridge::iohidmanager_swift_keys_standard_type_ansi() }
}