muse2/region.rs
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
//! Regions represent different geographical areas in which agents, processes, etc. are active.
use itertools::Itertools;
use serde::Deserialize;
use std::collections::HashSet;
use std::fmt::Display;
use std::rc::Rc;
/// Represents a region with an ID and a longer description.
#[derive(Debug, Deserialize, PartialEq)]
pub struct Region {
/// A unique identifier for a region (e.g. "GBR").
pub id: Rc<str>,
/// A text description of the region (e.g. "United Kingdom").
pub description: String,
}
/// Represents multiple regions
#[derive(PartialEq, Debug, Clone, Default)]
pub enum RegionSelection {
/// All regions are covered
#[default]
All,
/// Only some regions are covered
Some(HashSet<Rc<str>>),
}
impl RegionSelection {
/// Returns true if the [`RegionSelection`] covers a given region
pub fn contains(&self, region_id: &str) -> bool {
match self {
Self::All => true,
Self::Some(regions) => regions.contains(region_id),
}
}
}
impl Display for RegionSelection {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Self::All => write!(f, "all"),
Self::Some(regions) => write!(f, "{}", regions.iter().join(", ")),
}
}
}