peeringdb-rs 0.2.0

A unofficial library helps accessing PeeringDB data.
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

//! `netixlan` objects links net to ixlan and then to ix
//!
//! This is a useful data to connect ASNs to IXes and find connected networks that share the same IX
//! connectivity.

use crate::data::utils::get_reader_with_params;
use anyhow::Result;
use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use std::net::IpAddr;

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PeeringdbNetixlan {
    pub id: u32,
    pub net_id: Option<u32>,
    pub ix_id: Option<u32>,
    pub name: Option<String>,
    pub ixlan_id: Option<u32>,
    pub notes: Option<String>,
    pub speed: Option<u64>,
    pub asn: Option<u32>,
    pub ipaddr4: Option<IpAddr>,
    pub ipaddr6: Option<IpAddr>,
    pub is_rs_peer: Option<bool>,
    pub bfd_support: Option<bool>,
    pub operational: Option<bool>,
    pub created: Option<DateTime<Utc>>,
    pub updated: Option<DateTime<Utc>>,
    pub status: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PeeringdbNetixlanResponse {
    pub data: Vec<PeeringdbNetixlan>,
}

pub fn load_peeringdb_netixlan() -> Result<Vec<PeeringdbNetixlan>> {
    load_peeringdb_netixlan_filtered(&[])
}

/// Same as [load_peeringdb_netixlan], filtered by PeeringDB API query parameters,
/// e.g. `&[("ix_id", "26")]`. See the [list netixlan][api] documentation for the available
/// fields.
///
/// [api]: https://www.peeringdb.com/apidocs/#tag/api/operation/list%20netixlan
pub fn load_peeringdb_netixlan_filtered(params: &[(&str, &str)]) -> Result<Vec<PeeringdbNetixlan>> {
    let mut reader = get_reader_with_params("https://www.peeringdb.com/api/netixlan", params)?;
    let mut buf = String::new();
    reader.read_to_string(&mut buf)?;
    let res: PeeringdbNetixlanResponse = serde_json::from_str(&buf)?;
    Ok(res.data)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_loading_data() {
        let vec = load_peeringdb_netixlan().unwrap();
        dbg!(&vec[0]);
        // org records also deserialize into PeeringdbNetixlan (only `id` is required),
        // so check for a netixlan-specific field to make sure we hit the right endpoint
        assert!(vec.iter().any(|n| n.asn.is_some()));
    }
}