packtrack 3.0.1

A simple CLI for tracking mail packages
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

use crate::utils::UtcTime;
use std::fmt::Display;

#[derive(Debug, Clone)]
pub struct Package {
    pub barcode:    String,
    pub channel:    String,
    pub status:     PackageStatus,
    pub sender:     Option<String>,
    pub recipient:  Option<String>,
    pub eta:        Option<UtcTime>,
    pub eta_window: Option<TimeWindow>,
    pub delivered:  Option<UtcTime>,
    pub events:     Vec<Event>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct TimeWindow {
    pub start: UtcTime,
    pub end:   UtcTime,
}
#[derive(Debug, Clone)]
pub struct Event {
    pub timestamp: UtcTime,
    pub text:      String,
}

#[derive(Debug, Hash, PartialEq, Eq, Clone)]
pub enum PackageStatus {
    Delivered,
    DeliveredToNeighbour { address: String },
    InTransit,
}
impl PackageStatus {
    /// A status is "final" if the status will not change anymore, and there
    /// will be no more updates.
    pub fn is_final(&self) -> bool {
        use PackageStatus::*;
        match self {
            Delivered => true,
            DeliveredToNeighbour { address: _ } => true,
            _ => false,
        }
    }
}
impl Display for PackageStatus {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        // just using debug for now
        write!(f, "{self:?}")
    }
}

/// Contains the configurable stuff for Tracker
#[derive(Clone)]
pub struct TrackerContext<'a> {
    /// Postcode of the recipient (sometimes necessary to get full data from
    /// the API)
    pub recipient_postcode: Option<&'a str>,
    /// Preferred language (usually passed as a query param to the API)
    pub language:           &'a str,
}