machinebox 0.5.0

A client SDK for communicating with machinebox boxes
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

use super::Result;
use super::{Error, Kind};

/// Represents a detected face in an image
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct Face {
    /// Bounds and position of the detected face
    pub rect: Rect,
    /// ID of the face
    #[serde(default)]
    pub id: Option<String>,
    /// Trained/taught name of the face
    #[serde(default)]
    pub name: Option<String>,
    /// Indicates whether the face was matched
    pub matched: bool,
    /// Confidence rating of the match
    pub confidence: f64,
}

/// The bounds and position of a rectangle in which a face was detected
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct Rect {
    /// Vertical offset of the top of the rectangle
    pub top: isize,
    /// Horizontal offset of the left side of the rectangle
    pub left: isize,
    /// Width of the rectangle
    pub width: isize,
    /// Height of the rectangle
    pub height: isize,
}

/// The name and ID of a face detected as similar to a search target
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct Similar {
    /// ID of the face
    pub id: String,
    /// Name of the detected face
    pub name: String,
}

#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct SimilarResponseFull {
    pub success: bool,
    #[serde(default)]
    pub error: Option<String>,
    #[serde(default)]
    pub similar: Vec<Similar>,
}

/// Response from `facebox` when detecting similar faces
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct SimilarResponse {
    /// Vector of similar faces
    #[serde(default)]
    pub similar: Vec<Similar>,
}

impl Into<Result<SimilarResponse>> for SimilarResponseFull {
    fn into(self) -> Result<SimilarResponse> {
        if self.success {
            Ok(SimilarResponse { similar: self.similar })
        } else {
            let s = match self.error {
                Some(s) => s,
                None => "Request failed".to_owned(),
            };
            Err(Error {
                kind: Kind::Machinebox(s),
            })
        }
    }
}

#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct CheckResponseFull {
    pub success: bool,
    #[serde(default)]
    pub error: Option<String>,
    #[serde(default)]
    pub faces: Vec<Face>,
}

/// This struct contains a vector of faces identified within the supplied image
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct CheckResponse {
    /// List of identified faces
    pub faces: Vec<Face>,
}

#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct RenameRequest {
    pub name: String,
}


impl Into<Result<CheckResponse>> for CheckResponseFull {
    fn into(self) -> Result<CheckResponse> {
        if self.success {
            Ok(CheckResponse { faces: self.faces })
        } else {
            let s = match self.error {
                Some(s) => s,
                None => "Request failed".to_owned(),
            };
            Err(Error {
                kind: Kind::Machinebox(s),
            })
        }
    }
}