warb 0.1.0

Unofficial Rust bindings compatible with Blackmagic Design Blackmagic RAW. Not affiliated with or endorsed by Blackmagic Design.
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

use std::fmt::{self, Display, Formatter};

/// Error type for the crate. Wraps SDK failure messages, path conversion
/// errors, and invariant violations in a single stringly-typed variant —
/// there isn't much the caller can discriminate on that isn't already in
/// the message.
#[derive(Debug)]
pub struct BrawError(String);

impl BrawError {
    pub(crate) fn new(msg: impl Into<String>) -> Self {
        Self(msg.into())
    }
}

impl Display for BrawError {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        f.write_str(&self.0)
    }
}

impl std::error::Error for BrawError {}

impl From<cxx::Exception> for BrawError {
    fn from(e: cxx::Exception) -> Self {
        Self(e.what().to_string())
    }
}

/// BMD HRESULT code, surfaced to callbacks. `is_ok()` iff `>= 0` per
/// standard COM convention.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct HResult(pub i32);

impl HResult {
    pub const S_OK: HResult = HResult(0);

    pub fn is_ok(self) -> bool {
        self.0 >= 0
    }
    pub fn is_err(self) -> bool {
        self.0 < 0
    }
}

impl Display for HResult {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        write!(f, "HRESULT=0x{:08x}", self.0 as u32)
    }
}

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

    #[test]
    fn hresult_sign_classification() {
        assert!(HResult(0).is_ok());
        assert!(HResult(1).is_ok());
        assert!(HResult(i32::MAX).is_ok());
        assert!(HResult(-1).is_err());
        assert!(HResult(i32::MIN).is_err());
    }

    #[test]
    fn hresult_s_ok_is_zero() {
        assert_eq!(HResult::S_OK, HResult(0));
        assert!(HResult::S_OK.is_ok());
    }

    #[test]
    fn hresult_display_format() {
        assert_eq!(format!("{}", HResult(0)), "HRESULT=0x00000000");
        // E_POINTER from COM: 0x80004003 (negative as i32).
        assert_eq!(
            format!("{}", HResult(0x8000_4003u32 as i32)),
            "HRESULT=0x80004003"
        );
    }

    #[test]
    fn braw_error_display_passes_through() {
        let e = BrawError::new("boom");
        assert_eq!(format!("{e}"), "boom");
    }
}