hailort-sys 0.1.1

Raw FFI bindings to the HailoRT C runtime library
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

//! Opaque C handle types.
//!
//! In C these are declared as `typedef struct _foo *foo;` — pointers to
//! incomplete (forward-declared) structs.  The idiomatic Rust FFI pattern is
//! an uninhabited enum: Rust can hold and pass the pointer but never
//! construct or dereference the pointee without an explicit `unsafe` block.

use std::os::raw::c_void;

/// Opaque handle to a physical Hailo device.
pub enum hailo_device_opaque {}
pub type hailo_device = *mut hailo_device_opaque;

/// Opaque handle to a virtual device (may aggregate multiple physical devices).
pub enum hailo_vdevice_opaque {}
pub type hailo_vdevice = *mut hailo_vdevice_opaque;

/// Opaque handle to a loaded HEF (Hailo Executable Format) model file.
pub enum hailo_hef_opaque {}
pub type hailo_hef = *mut hailo_hef_opaque;

pub enum hailo_input_stream_opaque {}
pub type hailo_input_stream = *mut hailo_input_stream_opaque;

pub enum hailo_output_stream_opaque {}
pub type hailo_output_stream = *mut hailo_output_stream_opaque;

pub enum hailo_configured_network_group_opaque {}
pub type hailo_configured_network_group = *mut hailo_configured_network_group_opaque;

pub enum hailo_activated_network_group_opaque {}
pub type hailo_activated_network_group = *mut hailo_activated_network_group_opaque;

pub enum hailo_input_transform_context_opaque {}
pub type hailo_input_transform_context = *mut hailo_input_transform_context_opaque;

pub enum hailo_output_transform_context_opaque {}
pub type hailo_output_transform_context = *mut hailo_output_transform_context_opaque;

pub enum hailo_output_demuxer_opaque {}
pub type hailo_output_demuxer = *mut hailo_output_demuxer_opaque;

pub enum hailo_input_vstream_opaque {}
pub type hailo_input_vstream = *mut hailo_input_vstream_opaque;

pub enum hailo_output_vstream_opaque {}
pub type hailo_output_vstream = *mut hailo_output_vstream_opaque;

/// Scan-devices parameter block.
///
/// This type is opaque in the upstream header; only a null pointer is accepted
/// by the current API.  Pass `std::ptr::null_mut()` to `hailo_scan_devices`.
pub type hailo_scan_devices_params_t = c_void;

#[cfg(test)]
mod tests {
    use super::*;
    use std::mem::size_of;

    #[test]
    fn all_handle_types_are_pointer_sized() {
        let ptr = size_of::<*mut ()>();
        assert_eq!(size_of::<hailo_device>(), ptr);
        assert_eq!(size_of::<hailo_vdevice>(), ptr);
        assert_eq!(size_of::<hailo_hef>(), ptr);
        assert_eq!(size_of::<hailo_input_stream>(), ptr);
        assert_eq!(size_of::<hailo_output_stream>(), ptr);
        assert_eq!(size_of::<hailo_configured_network_group>(), ptr);
        assert_eq!(size_of::<hailo_activated_network_group>(), ptr);
        assert_eq!(size_of::<hailo_input_transform_context>(), ptr);
        assert_eq!(size_of::<hailo_output_transform_context>(), ptr);
        assert_eq!(size_of::<hailo_output_demuxer>(), ptr);
        assert_eq!(size_of::<hailo_input_vstream>(), ptr);
        assert_eq!(size_of::<hailo_output_vstream>(), ptr);
    }
}