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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
//! This crate provides types and methods for parsing/ creating [FCP](https://github.com/insomnimus/fcp) requests.
//!
//! # Examples
//!
//! ```
//! use fancp::{Request, AdjRequest, GetRequest, SetRequest};
//!
//! // Imagine we have an incoming fcp request
//! // over some connection. We can parse the request like this.
//! let req= "GET all"; // the bytes we received over the connection
//! let req = Request::parse(req).unwrap();
//! assert_eq!(Request::Get(GetRequest::All), req);
//!
//! // We can also use the string extension method:
//! let req: Request = "SET v500".parse().unwrap();
//! assert_eq!(Request::Set(SetRequest::Voltage(500)), req);
//!
//! // On the client side, we may form requests like this:
//! let req = Request::Adj(AdjRequest::Voltage(-25));
//! let req_string= format!("{};", &req); // fcp requests are ';' terminated
//! assert_eq!("ADJ v-25;", req_string.as_str());

#![cfg_attr(not(test), no_std)]

#[cfg(test)]
mod tests;

use core::{
    fmt,
    str::{self, FromStr},
};
use Error::*;

type Result<T> = core::result::Result<T, Error>;

/// Crate specific (not FCP bound) errors that may be returned trying to parse Requests.
#[derive(Debug, PartialEq, Eq)]
pub enum Error {
    /// The request method word is unknown. For example "FETCH x" (FETCH is invalid).
    UnknownRequestType,
    /// The request has an invalid value. For example "GET shoesize".
    InvalidValue,
    /// The request consists of just the method. For example "SET".
    MissingValue,
    /// The request is empty. For example "".
    Empty,
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            "{}",
            match self {
                Self::Empty => "empty request",
                Self::UnknownRequestType => "unknown request type",
                Self::InvalidValue => "invalid value",
                Self::MissingValue => "missing value",
            }
        )
    }
}

/// Types of FCP requests.
#[derive(Debug, PartialEq, Eq)]
pub enum Request {
    /// The `GET`request.
    Get(GetRequest),
    /// The `SET` request.
    Set(SetRequest),
    /// The `ADJ` (adjust) request.
    Adj(AdjRequest),
}

impl fmt::Display for Request {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Self::Get(r) => write!(f, "GET {}", r.val_str()),
            Self::Set(r) => {
                use SetRequest::*;
                match r {
                    Voltage(v) => write!(f, "SET v{}", v),
                    Percentage(v) => write!(f, "SET %{}", v),
                    Auto => write!(f, "SET a"),
                }
            }
            Self::Adj(r) => {
                use AdjRequest::*;
                match r {
                    Voltage(v) => write!(f, "ADJ v{}", v),
                    Percentage(v) => write!(f, "ADJ %{}", v),
                }
            }
        }
    }
}

impl Request {
    /// Tries to parse a slice of bytes into a Request.
    ///
    /// # Errors
    /// `parse` will error if the string is not a valid FCP request.
    ///
    /// # Examples
    ///
    /// ```
    /// use fancp::{Request, SetRequest};
    /// let req = "SET %25";
    /// assert_eq!(Ok(Request::Set(SetRequest::Percentage(25))), Request::parse(req));
    /// ```
    pub fn parse(s: &str) -> Result<Self> {
        let mut split = s.split_ascii_whitespace();
        let method = match split.next() {
            None => return Err(Empty),
            Some(x) => x,
        };
        if let Some(val) = split.next() {
            match method {
                "GET" => GetRequest::parse(val.as_bytes()).map(Self::Get),
                "SET" => SetRequest::parse(val.as_bytes()).map(Self::Set),
                "ADJ" => AdjRequest::parse(val.as_bytes()).map(Self::Adj),
                _ => Err(UnknownRequestType),
            }
        } else {
            match method {
                "GET" | "SET" | "ADJ" => Err(MissingValue),
                "" => Err(Empty),
                _ => Err(UnknownRequestType),
            }
        }
    }

    /// Returns the method name, as a static &str.
    ///
    /// # Examples
    ///
    /// ```
    /// use fancp::{Request, GetRequest};
    /// let req = Request::Get(GetRequest::Config);
    /// assert_eq!("GET", req.method());
    /// ```
    pub fn method(&self) -> &'static str {
        match self {
            Self::Get(_) => "GET",
            Self::Set(_) => "SET",
            Self::Adj(_) => "ADJ",
        }
    }
}

impl FromStr for Request {
    type Err = Error;
    fn from_str(s: &str) -> Result<Self> {
        Self::parse(s)
    }
}

/// Types of `GET` FCP requests.
#[derive(Debug, PartialEq, Eq)]
pub enum GetRequest {
    All,
    Config,
    Percentage,
    Temperature,
    Voltage,
}

impl GetRequest {
    fn parse(val: &[u8]) -> Result<Self> {
        use GetRequest::*;
        Ok(match val {
            b"all" => All,
            b"%" => Percentage,
            b"cfg" => Config,
            b"volt" => Voltage,
            b"temp" => Temperature,
            _ => return Err(InvalidValue),
        })
    }

    pub fn val_str(&self) -> &'static str {
        match self {
            Self::All => "all",
            Self::Voltage => "volt",
            Self::Config => "cfg",
            Self::Temperature => "temp",
            Self::Percentage => "%",
        }
    }
}

/// Types of `SET` FCP requests.
#[derive(Debug, PartialEq, Eq)]
pub enum SetRequest {
    Auto,
    Voltage(u16),
    Percentage(u8),
}

impl SetRequest {
    fn parse(val: &[u8]) -> Result<Self> {
        use SetRequest::*;
        if val.is_empty() {
            return Err(MissingValue);
        }
        unsafe {
            Ok(match val[0] {
                b'a' if val.len() == 1 => Auto,
                b'v' => {
                    if let Ok(n) = str::from_utf8_unchecked(&val[1..]).parse::<u16>() {
                        Voltage(n)
                    } else {
                        return Err(InvalidValue);
                    }
                }
                b'%' => {
                    if let Ok(n) = str::from_utf8_unchecked(&val[1..]).parse::<u8>() {
                        Percentage(n)
                    } else {
                        return Err(InvalidValue);
                    }
                }
                _ => return Err(InvalidValue),
            })
        }
    }
}

/// Types of `ADJ` (adjust) FCP requests.
#[derive(Debug, PartialEq, Eq)]
pub enum AdjRequest {
    Voltage(i16),
    Percentage(i8),
}

impl AdjRequest {
    fn parse(val: &[u8]) -> Result<Self> {
        use AdjRequest::*;
        if val.is_empty() {
            return Err(MissingValue);
        }
        unsafe {
            match val[0] {
                b'v' => {
                    if let Ok(n) = str::from_utf8_unchecked(&val[1..]).parse::<i16>() {
                        Ok(Voltage(n))
                    } else {
                        Err(InvalidValue)
                    }
                }
                b'%' => {
                    if let Ok(n) = str::from_utf8_unchecked(&val[1..]).parse::<i8>() {
                        Ok(Percentage(n))
                    } else {
                        Err(InvalidValue)
                    }
                }
                _ => Err(InvalidValue),
            }
        }
    }
}