orbbec-sdk 0.1.0

High-level bindings to Orbbec SDK v2
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

//! Error module
use crate::sys::OBError;
use crate::sys::enums::OBExceptionType;

use std::{error::Error, fmt};

/// Detailed error information
#[derive(Debug)]
pub struct OrbbecErrorData {
    /// Detailed error log
    pub message: String,
    /// Function where the error occurred
    pub function: String,
    /// Arguments passed to the function
    pub args: String,
}

/// Orbbec errors
#[derive(Debug)]
pub enum OrbbecError {
    /// Unknown error, an error not clearly defined by the SDK
    Unknown(OrbbecErrorData),
    /// Standard exception, an error caused by the standard library (cpp)
    StdException(OrbbecErrorData),
    /// Camera/Device has been disconnected, the camera/device is not available
    CameraDisconnected(OrbbecErrorData),
    /// An error in the SDK adaptation platform layer, which means an error in the implementation of a specific system platform
    PlatformException(OrbbecErrorData),
    /// Invalid parameter type exception, need to check input parameter
    InvalidValue(OrbbecErrorData),
    /// Wrong API call sequence, the API is called in the wrong order or the wrong parameter is passed
    WrongAPICallSequence(OrbbecErrorData),
    /// SDK and firmware have not yet implemented this function or feature
    NotImplemented(OrbbecErrorData),
    /// SDK access I/O exception error
    IOException(OrbbecErrorData),
    /// SDK access and use memory errors. For example, the frame fails to allocate memory
    MemoryException(OrbbecErrorData),
    /// Unsupported operation type error by SDK or device
    UnsupportedOperation(OrbbecErrorData),
}

impl fmt::Display for OrbbecError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            OrbbecError::Unknown(data) => write!(f, "Unknown Error: {}", data.message),
            OrbbecError::StdException(data) => write!(f, "Standard Exception: {}", data.message),
            OrbbecError::CameraDisconnected(data) => {
                write!(f, "Camera Disconnected: {}", data.message)
            }
            OrbbecError::PlatformException(data) => {
                write!(f, "Platform Exception: {}", data.message)
            }
            OrbbecError::InvalidValue(data) => write!(f, "Invalid Value: {}", data.message),
            OrbbecError::WrongAPICallSequence(data) => {
                write!(f, "Wrong API Call Sequence: {}", data.message)
            }
            OrbbecError::NotImplemented(data) => write!(f, "Not Implemented: {}", data.message),
            OrbbecError::IOException(data) => write!(f, "I/O Exception: {}", data.message),
            OrbbecError::MemoryException(data) => write!(f, "Memory Exception: {}", data.message),
            OrbbecError::UnsupportedOperation(data) => {
                write!(f, "Unsupported Operation: {}", data.message)
            }
        }
    }
}

impl Error for OrbbecError {}

impl From<&OBError> for OrbbecError {
    fn from(err: &OBError) -> Self {
        let message = err.message();
        let function = err.function();
        let args = err.args();
        let exception_type = err.exception_type();

        let data = OrbbecErrorData {
            message,
            function,
            args,
        };

        match exception_type {
            OBExceptionType::Unknown => OrbbecError::Unknown(data),
            OBExceptionType::StdException => OrbbecError::StdException(data),
            OBExceptionType::CameraDisconnected => OrbbecError::CameraDisconnected(data),
            OBExceptionType::PlatformException => OrbbecError::PlatformException(data),
            OBExceptionType::InvalidValue => OrbbecError::InvalidValue(data),
            OBExceptionType::WrongAPICallSequence => OrbbecError::WrongAPICallSequence(data),
            OBExceptionType::NotImplemented => OrbbecError::NotImplemented(data),
            OBExceptionType::IOException => OrbbecError::IOException(data),
            OBExceptionType::MemoryException => OrbbecError::MemoryException(data),
            OBExceptionType::UnsupportedOperation => OrbbecError::UnsupportedOperation(data),
        }
    }
}

impl From<OBError> for OrbbecError {
    fn from(err: OBError) -> Self {
        OrbbecError::from(&err)
    }
}