sota 0.7.0-rc4

API crate for Summits on the Air
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

#![warn(missing_docs)]
//! sota-rs is a crate for interfacing with the Summits on the Air API.
pub mod alert;
pub mod assoc;
pub mod callsign;
pub mod client;
pub mod spot;
pub mod summit;

use std::{fmt::Display, hash::Hash, str::FromStr};

use serde::{de::DeserializeOwned, Serialize};
use serde_with::{DeserializeFromStr, SerializeDisplay};

pub use crate::{
    alert::Alert, callsign::Callsign, client::Client, spot::Spot, summit::Summit,
    summit::SummitRestriction,
};

/// A spot or alert.
#[allow(missing_docs)]
pub trait Notice: Hash + Eq + DeserializeOwned + Serialize {
    fn callsign(&self) -> &Callsign;
    fn timestamp(&self) -> String;
    fn epoch(&self) -> &str;
}

/// An item that stores a full summit code.
pub trait HasSummit {
    /// Return the full summit code, e.g. "W6/CC-063".
    fn summit_code(&self) -> String;
}

#[allow(clippy::upper_case_acronyms, missing_docs)]
#[derive(Debug, Clone, PartialEq, Eq, Hash, SerializeDisplay, DeserializeFromStr)]
pub enum Mode {
    AM,
    CW,
    Data,
    DV,
    FM,
    SSB,
    Other,
}

impl FromStr for Mode {
    type Err = std::fmt::Error;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let mode = match s.to_lowercase().as_ref() {
            "am" => Mode::AM,
            "cw" => Mode::CW,
            "data" => Mode::Data,
            "dv" => Mode::DV,
            "fm" => Mode::FM,
            "ssb" => Mode::SSB,
            _ => Mode::Other,
        };
        Ok(mode)
    }
}

impl Display for Mode {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{:?}", self)
    }
}