kinect 0.0.6

A high level interface for Azure Kinect
Documentation
//! Crate error types

use std::fmt;
use std::error::Error;

/// Represents errors creating images with `k4a_image_create`.
#[derive(Copy, Clone, Debug)]
pub struct CreateImageError {
    /// The error code returned by libk4a.
    pub error_code: i32,
}

impl fmt::Display for CreateImageError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "CreateImageError (code: {})", self.error_code)
    }
}

impl Error for CreateImageError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        None
    }
}

/// Represents errors opening devices with `k4a_device_get_calibration`.
#[derive(Copy, Clone, Debug)]
pub enum DeviceGetCalibrationError {
    /// Failed to get device calibration.
    FailedError,
    /// Unexpected error code returned by libk4a.
    UnexpectedError(i32),
}

impl fmt::Display for DeviceGetCalibrationError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            DeviceGetCalibrationError::FailedError =>
                write!(f, "DeviceGetCalibrationError::FailedError"),
            DeviceGetCalibrationError::UnexpectedError(code) =>
                write!(f, "DeviceGetCalibrationError::UnexpectedError (code: {})", code),
        }
    }
}

impl Error for DeviceGetCalibrationError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        None
    }
}

/// Represents errors opening devices with `k4a_device_get_capture`.
#[derive(Copy, Clone, Debug)]
pub enum DeviceGetCaptureError {
    /// It took too long to get the capture, and our timeout elapsed.
    /// Error contains the original value of our timeout threshold (not the time elapsed).
    TimeoutError { timeout_millis: i32 },
    /// There was a failure in getting the capture
    FailedError,
    /// Unexpected error code returned by libk4a
    UnexpectedError(i32),
}

impl fmt::Display for DeviceGetCaptureError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            DeviceGetCaptureError::TimeoutError { timeout_millis }=>
                write!(f, "DeviceGetCaptureError::TimeoutError (timeout of {} millis elapsed)",
                       timeout_millis ),
            DeviceGetCaptureError::FailedError =>
                write!(f, "DeviceGetCaptureError::FailedError"),
            DeviceGetCaptureError::UnexpectedError(code) =>
                write!(f, "DeviceGetCaptureError::UnexpectedError (code: {})", code),
        }
    }
}

impl Error for DeviceGetCaptureError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        None
    }
}

/// Represents errors getting device serial numbers with `k4a_device_get_serialnum`.
#[derive(Copy, Clone, Debug)]
pub enum DeviceGetSerialNumberError {
    /// Buffering error during initial request (1st API call).
    CouldNotRequestError,
    /// Buffering error when reading serial number (2nd API call).
    CouldNotReadError,
    /// Could not format as a UTF-8 string.
    CouldNotFormatError,
}

impl fmt::Display for DeviceGetSerialNumberError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            DeviceGetSerialNumberError::CouldNotRequestError =>
                write!(f, "DeviceGetSerialNumberError::CouldNotRequestError"),
            DeviceGetSerialNumberError::CouldNotReadError =>
                write!(f, "DeviceGetSerialNumberError::CouldNotReadError"),
            DeviceGetSerialNumberError::CouldNotFormatError =>
                write!(f, "DeviceGetSerialNumberError::CouldNotFormatError"),
        }
    }
}

impl Error for DeviceGetSerialNumberError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        None
    }
}

/// Represents errors opening devices with `k4a_device_open`.
#[derive(Copy, Clone, Debug)]
pub struct DeviceOpenError {
    pub error_code: i32,
}

impl fmt::Display for DeviceOpenError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "DeviceOpenError (code: {})", self.error_code)
    }
}

impl Error for DeviceOpenError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        None
    }
}

/// Represents errors opening devices with `k4a_device_start_cameras`.
#[derive(Copy, Clone, Debug)]
pub struct DeviceStartCamerasError {
    /// The error code returned by libk4a.
    pub error_code: i32,
}

impl fmt::Display for DeviceStartCamerasError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "DeviceStartCamerasError (code: {})", self.error_code)
    }
}

impl Error for DeviceStartCamerasError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        None
    }
}