libdivecomputer 0.1.1

Safe bindings for libdivecomputer-sys
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

use std::ffi::{CStr, c_void};
use std::ptr;

use libdivecomputer_sys::{
    dc_descriptor_free, dc_descriptor_get_model, dc_descriptor_get_product,
    dc_descriptor_get_transports, dc_descriptor_get_type, dc_descriptor_get_vendor,
    dc_descriptor_iterator, dc_descriptor_t, dc_iterator_free, dc_iterator_next, dc_iterator_t,
};

use crate::common::{Family, Status, Transport};

/// A struct representing a DiveComputer.
///
#[derive(Debug)]
pub struct DiveComputer {
    vendor: String,
    product: String,
    model: u32,
    kind: Family,
    transports: Vec<Transport>,
}

impl DiveComputer {
    pub fn vendor(&self) -> &str {
        &self.vendor
    }

    pub fn product(&self) -> &str {
        &self.product
    }

    pub fn model(&self) -> u32 {
        self.model
    }

    pub fn kind(&self) -> Family {
        self.kind
    }

    pub fn transport(&self) -> &[Transport] {
        &self.transports
    }
}

impl TryFrom<Item> for DiveComputer {
    type Error = String;

    fn try_from(value: Item) -> Result<Self, Self::Error> {
        if value.ptr.is_null() {
            return Err("null pointer".into());
        }

        unsafe {
            let vendor = CStr::from_ptr(dc_descriptor_get_vendor(value.ptr as *mut _))
                .to_string_lossy()
                .to_string();
            let product = CStr::from_ptr(dc_descriptor_get_product(value.ptr as *mut _))
                .to_string_lossy()
                .to_string();
            let model = dc_descriptor_get_model(value.ptr as *mut _);
            let kind = Family::from(dc_descriptor_get_type(value.ptr as *mut _));
            let transports =
                Transport::vec_from_bitflag(dc_descriptor_get_transports(value.ptr as *mut _));

            let dive_computer = Self {
                vendor,
                product,
                model,
                kind,
                transports,
            };

            Ok(dive_computer)
        }
    }
}

struct Item {
    ptr: *mut dc_descriptor_t,
}

impl Default for Item {
    fn default() -> Self {
        Self {
            ptr: ptr::null_mut(),
        }
    }
}

impl Drop for Item {
    fn drop(&mut self) {
        unsafe {
            if !self.ptr.is_null() {
                dc_descriptor_free(self.ptr);
                self.ptr = ptr::null_mut();
            }
        }
    }
}
/// A struct representing a Descriptor.
///
/// # Examples
///
/// ```
/// use libdivecomputer::Descriptor;
///
/// let descriptor = Descriptor::default();
///
/// for dive_computer in descriptor {
///     println!("{dive_computer:?}");
/// }
/// ```
pub struct Descriptor {
    ptr: *mut dc_iterator_t,
}

impl Default for Descriptor {
    fn default() -> Self {
        unsafe {
            let mut ptr: *mut dc_iterator_t = ptr::null_mut();
            dc_descriptor_iterator(&mut ptr);

            Self { ptr }
        }
    }
}

impl Drop for Descriptor {
    fn drop(&mut self) {
        unsafe {
            if !self.ptr.is_null() {
                dc_iterator_free(self.ptr);
                self.ptr = ptr::null_mut();
            }
        }
    }
}

impl Iterator for Descriptor {
    type Item = DiveComputer;

    fn next(&mut self) -> Option<Self::Item> {
        unsafe {
            let mut item = Item::default();
            let status = dc_iterator_next(self.ptr, &mut item.ptr as *mut _ as *mut c_void);

            if status != Status::Success as i32 {
                return None;
            }

            DiveComputer::try_from(item).ok()
        }
    }
}