ancs 0.2.0

A set of types for representing Apple Notification Center Service requests and responses.
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
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

//! ## Attributes
//! 
//! Attributes are the smallest data entity defined by `GATT`. In the case of the ANCS service
//! there are a wide variety of Attributes that can be used. Please see the attributes module
//! provided by this library for which attributes are valid when working with ANCS.
//! 
pub mod app;
pub mod category;
pub mod command;
pub mod event;
pub mod notification;

use nom::{
    multi::count,
    number::complete::{le_u16, le_u8},
    IResult,
};
use std::fmt::Debug;

use self::{notification::NotificationAttributeID, app::AppAttributeID};

/// The `NotificationAttribute` type. See [the module level documentation](index.html) for more.
#[derive(Debug, PartialEq, Clone)]
pub struct NotificationAttribute {
    pub id: NotificationAttributeID, 
    pub length: u16, 
    pub value: Option<String>
}

impl From<NotificationAttribute> for Vec<u8> {
    /// Converts a `NotificationAttribute` to a `Vec<u8>`:
    /// 
    /// # Examples
    /// ```
    /// # use ancs::attributes::NotificationAttribute;
    /// # use ancs::attributes::notification::NotificationAttributeID;
    /// # let attribute_id = NotificationAttributeID::AppIdentifier;
    /// # let attribute_data = "test".to_string();
    /// # let attribute_length = attribute_data.as_bytes().len() as u16;
    /// let attribute: NotificationAttribute = NotificationAttribute {
    ///    id: attribute_id,
    ///    length: attribute_length,
    ///    value: Some(attribute_data)
    /// };
    /// 
    /// let converted_bytes: Vec<u8> = attribute.into();
    /// 
    /// assert_eq!(u8::MIN, converted_bytes[0]); // Identifier for attribute
    /// assert_eq!(4, converted_bytes[1]); // Length of attribute
    /// assert_eq!(0, converted_bytes[2]); // 4 doesn't need an extra byte so it's empty
    /// assert_eq!(116, converted_bytes[3]); // t string char
    /// assert_eq!(101, converted_bytes[4]); // e string char
    /// assert_eq!(115, converted_bytes[5]); // s string char
    /// assert_eq!(116, converted_bytes[6]); // t string char strings are not NULL terminated so this is the end
    /// ```
    fn from(original: NotificationAttribute) -> Vec<u8> {
        let mut vec: Vec<u8> = Vec::new();

        let id: u8 = original.id.into();
        let length: [u8; 2] = original.length.to_le_bytes();
        let attribute: Option<Vec<u8>> = match original.value {
            Some(value) => { Some(value.into_bytes()) },
            None => None,
        };

        vec.push(id);
        vec.extend(length.to_vec());

        // If the attribute's value isn't null we add it to our bytes.
        match attribute {
            Some(attribute) => { vec.extend(attribute)},
            None => (),
        };

        return vec;
    }
}

impl NotificationAttribute {
    /// Attempts to parse a `NotificationAttribute` from a `&[u8]`
    /// 
    /// # Examples
    /// 
    /// Convert a `NotificationAttribute` to a `Vec<u8>`:
    /// ```
    /// # use ancs::attributes::NotificationAttribute;
    /// # use ancs::attributes::notification::NotificationAttributeID;
    /// // Attribute Bytes Specificed by ANCS Standard
    /// let bytes: Vec<u8> = vec![0, 4, 0, 116, 101, 115, 116, 0];
    /// let (bytes, attribute) = NotificationAttribute::parse(&bytes).unwrap();
    /// 
    /// // Validate that all bytes were parsed per ANCS Standard
    /// assert_eq!(attribute.id, NotificationAttributeID::AppIdentifier);
    /// assert_eq!(attribute.length, 4);
    /// assert_eq!(attribute.value, Some("test".to_string()));
    /// 
    /// // Validate all remaining bytes are the same
    /// assert_eq!(bytes.len(), 1);
    /// assert_eq!(bytes, [0]);
    /// ```
    /// 
    pub fn parse(i: &[u8]) -> IResult<&[u8], NotificationAttribute> {
        let (i, id) = notification::NotificationAttributeID::parse(i)?;
        let (i, length) = le_u16(i)?;
        let (i, attribute) = count(le_u8, length.into())(i)?;

        Ok((
            i,
            NotificationAttribute {
                id: notification::NotificationAttributeID::try_from(id).unwrap(),
                length: length,
                value: Some(String::from_utf8(attribute).unwrap()),
            },
        ))
    }
}

/// The `AppAttribute` type. See [the module level documentation](index.html) for more.
#[derive(Debug, PartialEq, Clone)]
pub struct AppAttribute {
    pub id: AppAttributeID, 
    pub length: u16, 
    pub value: Option<String>
}

impl From<AppAttribute> for Vec<u8> {
    /// Converts a `AppAttribute` to a `Vec<u8>`:
    /// 
    /// # Examples
    /// ```
    /// # use ancs::attributes::AppAttribute;
    /// # use ancs::attributes::app::AppAttributeID;
    /// # let attribute_id = AppAttributeID::DisplayName;
    /// # let attribute_data = "test".to_string();
    /// # let attribute_length = attribute_data.as_bytes().len() as u16;
    /// let attribute: AppAttribute = AppAttribute {
    ///    id: attribute_id,
    ///    length: attribute_length,
    ///    value: Some(attribute_data)
    /// };
    /// 
    /// let converted_bytes: Vec<u8> = attribute.into();
    /// 
    /// assert_eq!(u8::MIN, converted_bytes[0]); // Identifier for attribute
    /// assert_eq!(4, converted_bytes[1]); // Length of attribute
    /// assert_eq!(0, converted_bytes[2]); // 4 doesn't need an extra byte so it's empty
    /// assert_eq!(116, converted_bytes[3]); // t string char
    /// assert_eq!(101, converted_bytes[4]); // e string char
    /// assert_eq!(115, converted_bytes[5]); // s string char
    /// assert_eq!(116, converted_bytes[6]); // t string char strings are not NULL terminated so this is the end
    /// ```
    fn from(original: AppAttribute) -> Vec<u8> {
        let mut vec: Vec<u8> = Vec::new();

        let id: u8 = original.id.into();
        let length: [u8; 2] = original.length.to_le_bytes();
        let attribute: Option<Vec<u8>> = match original.value {
            Some(value) => { Some(value.into_bytes()) },
            None => None,
        };

        vec.push(id);
        vec.extend(length.to_vec());

        // If the attribute's value isn't null we add it to our bytes.
        match attribute {
            Some(attribute) => { vec.extend(attribute)},
            None => (),
        };

        return vec;
    }
}

impl AppAttribute {
    /// Attempts to parse a `AppAttribute` from a `&[u8]`
    /// 
    /// # Examples
    /// 
    /// Convert a `AppAttribute` to a `Vec<u8>`:
    /// ```
    /// # use ancs::attributes::AppAttribute;
    /// # use ancs::attributes::app::AppAttributeID;
    /// // Attribute Bytes Specificed by ANCS Standard
    /// let bytes: Vec<u8> = vec![0, 4, 0, 116, 101, 115, 116, 0];
    /// let (bytes, attribute) = AppAttribute::parse(&bytes).unwrap();
    /// 
    /// // Validate that all bytes were parsed per ANCS Standard
    /// assert_eq!(attribute.id, AppAttributeID::DisplayName);
    /// assert_eq!(attribute.length, 4);
    /// assert_eq!(attribute.value, Some("test".to_string()));
    /// 
    /// // Validate all remaining bytes are the same
    /// assert_eq!(bytes.len(), 1);
    /// assert_eq!(bytes, [0]);
    /// ```
    /// 
    pub fn parse(i: &[u8]) -> IResult<&[u8], AppAttribute> {
        let (i, id) = app::AppAttributeID::parse(i)?;
        let (i, length) = le_u16(i)?;
        let (i, attribute) = count(le_u8, length.into())(i)?;

        Ok((
            i,
            AppAttribute {
                id: app::AppAttributeID::try_from(id).unwrap(),
                length: length,
                value: Some(String::from_utf8(attribute).unwrap()),
            },
        ))
    }
}