rfham_itu/lib.rs
1//! ITU frequency allocation, band, region, and callsign-series data.
2//!
3//! `rfham-itu` encodes the radio-frequency spectrum as defined by the International
4//! Telecommunication Union (ITU) and the International Amateur Radio Union (IARU).
5//!
6//! | Module | Key types | Purpose |
7//! |--------|-----------|---------|
8//! | [`allocations`] | [`allocations::FrequencyAllocation`] | IARU amateur band allocations per region |
9//! | [`bands`] | [`bands::FrequencyBand`] | ITU frequency band names (ELF … THF) |
10//! | [`regions`] | [`regions::Region`] | ITU Regions 1, 2, and 3 |
11//! | [`callsigns`] | [`callsigns::ItuSeriesAllocation`] | ITU callsign prefix–country mapping |
12//!
13//! # Examples
14//!
15//! ```rust
16//! use rfham_itu::allocations::FrequencyAllocation;
17//! use rfham_itu::bands::FrequencyBand;
18//! use rfham_core::frequency::megahertz;
19//!
20//! let band = FrequencyAllocation::classify(megahertz(146.52));
21//! assert_eq!(Some(FrequencyAllocation::Band2M), band);
22//!
23//! assert_eq!("VHF", FrequencyBand::VeryHigh.abbreviation());
24//! ```
25
26// use statements
27
28// ------------------------------------------------------------------------------------------------
29// Public Macros
30// ------------------------------------------------------------------------------------------------
31
32// ------------------------------------------------------------------------------------------------
33// Public Types
34// ------------------------------------------------------------------------------------------------
35
36// ------------------------------------------------------------------------------------------------
37// Public Functions
38// ------------------------------------------------------------------------------------------------
39
40// ------------------------------------------------------------------------------------------------
41// Private Types
42// ------------------------------------------------------------------------------------------------
43
44// ------------------------------------------------------------------------------------------------
45// Implementations
46// ------------------------------------------------------------------------------------------------
47
48// ------------------------------------------------------------------------------------------------
49// Private Functions
50// ------------------------------------------------------------------------------------------------
51
52// ------------------------------------------------------------------------------------------------
53// Modules
54// ------------------------------------------------------------------------------------------------
55
56pub mod allocations;
57pub mod bands;
58pub mod callsigns;
59pub mod regions;