geph5-broker-protocol 0.2.67

Broker protocol for Geph5
Documentation
use std::{
    collections::{BTreeMap, HashMap},
    net::SocketAddr,
    time::{Duration, SystemTime, UNIX_EPOCH},
};

use ed25519_dalek::VerifyingKey;
use isocountry::CountryCode;
use language_tags::LanguageTag;
use serde::{Deserialize, Serialize};

use crate::AccountLevel;

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
/// This fully describes a particular exit.
pub struct ExitDescriptor {
    /// The listening port for the client-to-exit protocol
    pub c2e_listen: SocketAddr,
    /// The listening port for the bridge-to-exit protocol
    pub b2e_listen: SocketAddr,
    /// The country code
    pub country: CountryCode,
    /// The city code
    pub city: String,
    /// How loaded the server is
    pub load: f32,
    /// When does this descriptor expire?
    pub expiry: u64,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
/// This fully describes all the available exits in the system.
pub struct ExitList {
    /// All the exits in the system
    pub all_exits: Vec<(VerifyingKey, ExitDescriptor)>,
    pub city_names: HashMap<String, HashMap<LanguageTag, String>>,
}

impl ExitList {
    /// A convenience method to find the overall expiry time of the exit list.
    pub fn expiry(&self) -> SystemTime {
        UNIX_EPOCH
            + Duration::from_secs(
                self.all_exits
                    .iter()
                    .map(|exit| exit.1.expiry)
                    .min()
                    .unwrap_or_default(),
            )
    }
}

#[derive(Serialize, Deserialize, Clone, Debug)]
/// This fully describes all the available exits in the system.
pub struct NetStatus {
    /// All the exits in the system.
    pub exits: BTreeMap<String, (VerifyingKey, ExitDescriptor, ExitMetadata)>,
}

impl NetStatus {
    /// A convenience method to find the overall expiry time of the NetStatus.
    pub fn expiry(&self) -> SystemTime {
        UNIX_EPOCH
            + Duration::from_secs(
                self.exits
                    .values()
                    .map(|exit| exit.1.expiry)
                    .min()
                    .unwrap_or_default(),
            )
    }
}

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct ExitMetadata {
    pub allowed_levels: Vec<AccountLevel>,
    pub category: ExitCategory,
}

#[derive(Serialize, Deserialize, Debug, Clone, Copy, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
pub enum ExitCategory {
    Core,
    Streaming,
}