hamcall 0.2.1

Ham Radio callsign analyzer and ClubLog XML parser
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

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

//! Trait definition on how to access ClubLog data.

use crate::clublog::{Adif, CallsignException, CqZone, Entity, Prefix};
use chrono::{DateTime, Utc};

/// Definitions on how to access ClubLog data
pub trait ClubLogQuery {
    /// Get entity information by adif identifier.
    ///
    /// # Arguments
    ///
    /// - `adif`: ADIF identifier
    /// - `timestamp`: Timestamp to use for the check
    ///
    /// # Returns
    ///
    /// Entity information, if present
    fn get_entity(&self, adif: Adif, timestamp: &DateTime<Utc>) -> Option<&Entity>;

    /// Get prefix information by callsign prefix.
    ///
    /// # Arguments
    ///
    /// - `prefix`: Callsigns prefix, like `DL`
    /// - `timestamp`: Timestamp to use for the check
    ///
    /// # Returns
    ///
    /// Prefix information, if present
    fn get_prefix(&self, prefix: &str, timestamp: &DateTime<Utc>) -> Option<&Prefix>;

    /// Get callsign exception information by callsign.
    ///
    /// # Arguments
    ///
    /// - `callsign`: Complete callsign
    /// - `timestamp`: Timestamp to use for the check
    ///
    /// # Returns
    ///
    /// Callsign exception information, if present
    fn get_callsign_exception(
        &self,
        callsign: &str,
        timestamp: &DateTime<Utc>,
    ) -> Option<&CallsignException>;

    /// Get cq zone by callsign if an exception for the callsign exists.
    ///
    /// # Arguments
    ///
    /// - `callsign`: Complete callsign
    /// - `timestamp`: Timestamp to use for the check
    ///
    /// # Returns
    ///
    /// CQ zone exception, if present
    fn get_zone_exception(&self, callsign: &str, timestamp: &DateTime<Utc>) -> Option<CqZone>;

    /// Check if the callsign was used in an invalid operation.
    ///
    /// # Arguments
    ///
    /// - `callsign`: Complete callsign
    /// - `timestamp`: Timestamp to use for the check
    ///
    /// # Returns
    ///
    /// True if the operation is invalid, false otherwise
    fn is_invalid_operation(&self, callsign: &str, timestamp: &DateTime<Utc>) -> bool;
}

/// Check whether a timestamp is within an optional start and end time range.
///
/// # Arguments
///
/// - `timestamp`: Timestamp to use for the check
/// - `start`: Start timestamp of the time window
/// - `end`: End timestamp of the time window
///
/// # Returns
///
/// True if time timestamp is within the time window, false otherwise
pub fn is_in_time_window(
    timestamp: &DateTime<Utc>,
    start: Option<DateTime<Utc>>,
    end: Option<DateTime<Utc>>,
) -> bool {
    match (start, end) {
        (Some(tstart), Some(tend)) => timestamp >= &tstart && timestamp <= &tend,
        (Some(tstart), None) => timestamp >= &tstart,
        (None, Some(tend)) => timestamp <= &tend,
        (None, None) => true,
    }
}