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

use nom::{
    number::complete::{le_u8},
    IResult,
};

/// Provides a set of identifiers for types of attributes that a consumer may require.
/// This list of `NotificationAttributeID`s follows the ANCS Specification for valid NotificationAttributeIDs
#[derive(Debug, PartialEq, Clone, Copy)]
pub enum NotificationAttributeID {
    AppIdentifier = 0,
    Title = 1,
    Subtitle = 2,
    Message = 3,
    MessageSize = 4,
    Date = 5,
    PositiveActionLabel = 6,
    NegativeActionLabel = 7,
}

impl From<NotificationAttributeID> for u8 {
    /// Convert a `NotificationAttributeID` to a `u8`:
    /// 
    /// # Examples
    /// ```
    /// # use ancs::attributes::notification::NotificationAttributeID;
    /// let data: u8 = NotificationAttributeID::AppIdentifier.into();
    /// 
    /// assert_eq!(0, data);
    /// ```
    fn from(original: NotificationAttributeID) -> u8 {
        match original {
            NotificationAttributeID::AppIdentifier => 0,
            NotificationAttributeID::Title => 1,
            NotificationAttributeID::Subtitle => 2,
            NotificationAttributeID::Message => 3,
            NotificationAttributeID::MessageSize => 4,
            NotificationAttributeID::Date => 5,
            NotificationAttributeID::PositiveActionLabel => 6,
            NotificationAttributeID::NegativeActionLabel => 7,
        }
    }
}

impl TryFrom<u8> for NotificationAttributeID {
    type Error = ();

    /// Attempts to convert a `u8` to a `NotificationAttributeID`
    /// 
    /// # Examples
    /// ```
    /// # use ancs::attributes::notification::NotificationAttributeID;
    /// let attribute: NotificationAttributeID = NotificationAttributeID::try_from(0).unwrap();
    /// 
    /// assert_eq!(NotificationAttributeID::AppIdentifier, attribute);
    /// ```
    /// 
    fn try_from(original: u8) -> Result<Self, Self::Error> {
        match original {
            0 => Ok(NotificationAttributeID::AppIdentifier),
            1 => Ok(NotificationAttributeID::Title),
            2 => Ok(NotificationAttributeID::Subtitle),
            3 => Ok(NotificationAttributeID::Message),
            4 => Ok(NotificationAttributeID::MessageSize),
            5 => Ok(NotificationAttributeID::Date),
            6 => Ok(NotificationAttributeID::PositiveActionLabel),
            7 => Ok(NotificationAttributeID::NegativeActionLabel),
            _ => Err(()),
        }
    }
}

impl NotificationAttributeID {
    /// Attempts to parse a `NotificationAttributeID` from a `&[u8]`
    /// 
    /// # Examples
    /// ```
    /// # use ancs::attributes::notification::NotificationAttributeID;
    /// let data: [u8; 2] = [0, 1];
    /// let (data, attribute) = NotificationAttributeID::parse(&data).unwrap();
    /// 
    /// assert_eq!(NotificationAttributeID::AppIdentifier, attribute);
    /// ```
    /// 
    pub fn parse(i: &[u8]) -> IResult<&[u8], NotificationAttributeID> {
        let (i, attribute_id) = le_u8(i)?;

        Ok((i, NotificationAttributeID::try_from(attribute_id).unwrap()))
    }

    /// Determines if a `NotificationAttributeID` has a size based
    /// on requirements defined in the ANCS specification.
    /// 
    /// # Examples
    /// ```
    /// # use ancs::attributes::notification::NotificationAttributeID;
    /// let app_identifier = NotificationAttributeID::AppIdentifier;
    /// let title = NotificationAttributeID::Title;
    /// 
    /// assert_eq!(NotificationAttributeID::is_sized(app_identifier), false);
    /// assert_eq!(NotificationAttributeID::is_sized(title), true);
    /// ```
    /// 
    pub fn is_sized(id: NotificationAttributeID) -> bool {
        match id {
            NotificationAttributeID::Title => true,
            NotificationAttributeID::Subtitle => true,
            NotificationAttributeID::Message => true,
            _ => false
        }
    }
}