ohos-vibrator-binding 0.1.0

OpenHarmony's vibrator binding for rust
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

use ohos_vibrator_sys::{
    OH_Vibrator_Cancel, OH_Vibrator_PlayVibration, OH_Vibrator_PlayVibrationCustom,
    Vibrator_Attribute, Vibrator_FileDescription,
};

mod error;
mod usage;

pub use error::*;
pub use usage::*;

/// This function is used to cancel the vibration.
pub fn cancel() -> Result<(), VibratorError> {
    let ret = unsafe { OH_Vibrator_Cancel() };
    if ret != 0 {
        return Err(VibratorError::InternalError(ret));
    }
    Ok(())
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Attribute {
    pub vibrator_id: i32,
    pub usage: VibratorUsage,
}

impl Default for Attribute {
    fn default() -> Self {
        Self {
            vibrator_id: 0,
            usage: VibratorUsage::Unknown,
        }
    }
}

impl From<Attribute> for Vibrator_Attribute {
    fn from(attribute: Attribute) -> Self {
        Vibrator_Attribute {
            vibratorId: attribute.vibrator_id,
            usage: attribute.usage.into(),
        }
    }
}


/// Start the vibration.
/// ```rs
/// use ohos_vibrator_binding::{start, Attribute};
///
/// let attribute = Attribute {
///     usage: VibratorUsage::Unknown,
///     ..Default::default()
/// };
/// start(1000, attribute).unwrap();
/// ```
pub fn start(duration: i32, attribute: Attribute) -> Result<(), VibratorError> {
    let ret = unsafe { OH_Vibrator_PlayVibration(duration, attribute.into()) };
    if ret != 0 {
        return Err(VibratorError::InternalError(ret));
    }
    Ok(())
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct FileDescription {
    pub fd: i32,
    pub offset: u64,
    pub length: u64,
}

impl From<FileDescription> for Vibrator_FileDescription {
    fn from(file_description: FileDescription) -> Self {
        Vibrator_FileDescription {
            fd: file_description.fd,
            offset: file_description.offset as _,
            length: file_description.length as _,
        }
    }
}

/// Start the vibration with custom file description. Allow user to use custom vibration file.   
/// See details: https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/vibrator-guidelines#%E6%8C%AF%E5%8A%A8%E6%95%88%E6%9E%9C%E8%AF%B4%E6%98%8E
/// 
/// ```rs
/// #[napi]
/// pub fn custom_start() -> Result<()> {
///     let file_info = fs::File::open("/data/test/vibrator/coin_drop.json")
///         .map_err(|e| Error::from_reason(e.to_string()))?;
///     let file_description = FileDescription {
///         fd: file_info.as_raw_fd(),
///         offset: 0,
///         length: file_info.metadata().map_err(|e| Error::from_reason(e.to_string()))?.len(),
///     };
///     let attribute = Attribute {
///         usage: VibratorUsage::Alarm,
///         ..Default::default()
///     };
///     ohos_vibrator_binding::custom_start(file_description, attribute).unwrap();
///     Ok(())
/// }
/// ```
pub fn custom_start(
    file_description: FileDescription,
    attribute: Attribute,
) -> Result<(), VibratorError> {
    let ret = unsafe { OH_Vibrator_PlayVibrationCustom(file_description.into(), attribute.into()) };
    if ret != 0 {
        return Err(VibratorError::InternalError(ret));
    }
    Ok(())
}