sbd_lib 0.2.2

Rust library for parsing iridium sbd message
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

use crate::Result;
#[cfg(feature = "serde-derive")]
use serde::{Deserialize, Serialize};

/// The status of a mobile-originated session.
///
/// The descriptions for these codes are taken directly from the `DirectIP` documentation.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[cfg_attr(feature = "serde-derive", derive(Serialize, Deserialize))]
pub enum SessionStatus {
    /// The SBD session completed successfully.
    Ok = 0,
    /// The MO message transfer, if any, was successful. The MT message queued at the GSS is too
    /// large to be transferred within a single SBD session.
    OkMobileTerminatedTooLarge = 1,
    /// The MO message transfer, if any, was successful. The reported location was determined to be
    /// of unacceptable quality. This value is only applicable to IMEIs using SBD protocol revision
    /// 1.
    OkLocationUnacceptableQuality = 2,
    /// The SBD session timed out before session completion.
    Timeout = 10,
    /// The MO message being transferred by the IMEI is too large to be transerred within a single
    /// SBD session.
    MobileOriginatedTooLarge = 12,
    /// An RF link loss ocurred during the SBD session.
    RFLinkLoss = 13,
    /// An IMEI protocol anomaly occurred during SBD session.
    IMEIProtocolAnomaly = 14,
    /// The IMEI is prohibited from accessing the GSS.
    Prohibited = 15,
}

impl SessionStatus {
    /// Creates a new session status from a code.
    ///
    /// Returns an error if the code is unknown.
    ///
    /// # Examples
    ///
    /// ```
    /// use sbd_lib::mo::SessionStatus;
    /// assert!(SessionStatus::new(0).is_ok());
    /// assert!(SessionStatus::new(3).is_err());
    /// ```
    pub fn new(n: u8) -> Result<SessionStatus> {
        use crate::Error;
        match n {
            0 => Ok(SessionStatus::Ok),
            1 => Ok(SessionStatus::OkMobileTerminatedTooLarge),
            2 => Ok(SessionStatus::OkLocationUnacceptableQuality),
            10 => Ok(SessionStatus::Timeout),
            12 => Ok(SessionStatus::MobileOriginatedTooLarge),
            13 => Ok(SessionStatus::RFLinkLoss),
            14 => Ok(SessionStatus::IMEIProtocolAnomaly),
            15 => Ok(SessionStatus::Prohibited),
            _ => Err(Error::UnknownSessionStatus(n)),
        }
    }

    pub fn value(&self) -> i8 {
        *self as i8
    }

    pub fn is_ok(&self) -> bool {
        match self {
            SessionStatus::Ok
            | SessionStatus::OkMobileTerminatedTooLarge
            | SessionStatus::OkLocationUnacceptableQuality => true,
            SessionStatus::Timeout => false,
            SessionStatus::MobileOriginatedTooLarge => false,
            SessionStatus::RFLinkLoss => false,
            SessionStatus::IMEIProtocolAnomaly => false,
            SessionStatus::Prohibited => false,
        }
    }
}