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
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

//! Federated units of the program.

use serde::{Deserialize, Serialize};
use serde_with::serde_as;
use time::OffsetDateTime;

use crate::Callsign;

/// A SOTA association.
#[serde_as]
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Association {
    /// Association's code (e.g.: W6).
    pub association_code: String,
    /// Association's name (e.g.: "USA").
    pub association_name: String,
    /// Association's manager's name.
    pub manager: String,
    /// Association's manager's callsign.
    pub association_manager_callsign: Callsign,
    /// Date the association became active.
    #[serde(with = "time::serde::rfc3339")]
    pub active_from: OffsetDateTime,
    /// DXCC entity number of the association's country (e.g.: 291).
    pub dxcc: String,
    /// Northernmost boundary of association's area.
    pub max_lat: f32,
    /// Easternmost boundary of association's area.
    pub max_long: f32,
    /// Southernmost boundary of association's area.
    pub min_lat: f32,
    /// Westernmost boundary of association's area.
    pub min_long: f32,
    /// Number of regions belonging to association.
    pub regions_count: usize,
    /// Number of summits belonging to association.
    pub summits_count: usize,
    /// Assocation's regions' data.
    pub regions: Vec<Region>,
    /// Assocation's rulebooks' metadata.
    pub arm: Vec<ARM>,
}

/// A region of a SOTA association.
#[serde_as]
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Region {
    /// Association's code (e.g.: W6).
    pub association_code: String,
    /// Region's code (e.g.: CC).
    pub region_code: String,
    /// Region's manager's callsign.
    pub region_manager_callsign: String,
    /// Region's name (e.g.: Coastal Ranges).
    pub region_name: String,
    /// Region's manager's name.
    pub manager: String,
    /// Number of summits belonging to region.
    pub summits: usize,
    /// Notes about the region.
    pub notes: String,
    /// Northernmost boundary of region's area.
    pub max_lat: f32,
    /// Easternmost boundary of region's area.
    pub max_long: f32,
    /// Southernmost boundary of region's area.
    pub min_lat: f32,
    /// Westernmost boundary of region's area.
    pub min_long: f32,
}

/// An Association Reference Manual's metadata.
#[serde_as]
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct ARM {
    /// Association's code, e.g., "W6".
    pub association_code: String,
    /// ARM's filename.
    pub file_name: String,
    /// Language in which ARM is written.
    pub language: String,
    /// ARM's version.
    pub version_number: f32,
    /// Date ARM was last updated.
    #[serde(with = "time::serde::rfc3339")]
    pub last_updated: OffsetDateTime,
}

#[serde_as]
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct RegionResponse {
    pub region: Region,
    // Summits come back with a lot of null fields, and it's not worth converting all of those
    // to Options, so `.summits` is suppressed here.
}