Skip to main content

ipscanner/types/
directory.rs

1use serde::{Deserialize, Serialize};
2
3/// Query parameters for the ASN directory top list.
4#[derive(Debug, Clone, Default)]
5pub struct AsnTopParams {
6    /// How many to return, 1 to 1000. The server defaults to 100.
7    pub top: Option<u32>,
8    /// `addresses` (default) or `prefixes`.
9    pub by: Option<String>,
10}
11
12/// Response of `GET /v1/asn/directory?top=`.
13#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
14#[serde(default, rename_all = "camelCase")]
15pub struct AsnTop {
16    pub total: i64,
17    pub by: String,
18    pub count: i64,
19    pub results: Vec<AsnSummary>,
20}
21
22/// Response of `GET /v1/asn/directory?q=`.
23#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
24#[serde(default, rename_all = "camelCase")]
25pub struct AsnSearch {
26    pub total: i64,
27    pub query: String,
28    pub count: i64,
29    pub results: Vec<AsnSummary>,
30}
31
32/// An autonomous system in the directory.
33#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
34#[serde(default, rename_all = "camelCase")]
35pub struct AsnSummary {
36    pub asn: u32,
37    pub label: String,
38    pub org: String,
39    pub network_type: String,
40    pub ipv4_prefixes: i64,
41    pub ipv6_prefixes: i64,
42    pub prefixes: i64,
43    pub addresses: u64,
44}
45
46/// Response of `GET /v1/asn/directory/{asn}`.
47#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
48#[serde(default, rename_all = "camelCase")]
49pub struct AsnDetail {
50    pub asn: u32,
51    pub label: String,
52    pub org: String,
53    pub network_type: String,
54    pub ipv4_prefixes: i64,
55    pub ipv6_prefixes: i64,
56    pub prefixes: i64,
57    pub addresses: u64,
58    pub sample_prefixes: Vec<AsnPrefix>,
59    pub vpn_range_prefixes: i64,
60    pub datacenter_range_prefixes: i64,
61    /// Whether the two range counts are meaningful yet.
62    pub ranges_loaded: bool,
63}
64
65/// A sample prefix announced by an autonomous system.
66#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
67#[serde(default, rename_all = "camelCase")]
68pub struct AsnPrefix {
69    pub prefix: String,
70    pub version: i64,
71    pub addresses: Option<u64>,
72}
73
74/// Response of `GET /v1/crawlers`.
75#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
76#[serde(default, rename_all = "camelCase")]
77pub struct CrawlerList {
78    pub crawlers: Vec<Crawler>,
79    pub count: i64,
80    pub note: String,
81}
82
83/// A crawler this service can verify.
84#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
85#[serde(default, rename_all = "camelCase")]
86pub struct Crawler {
87    pub slug: String,
88    pub name: String,
89    pub tokens: Vec<String>,
90    pub method: String,
91    pub verifiable: bool,
92    pub reverse_dns: Vec<String>,
93    pub prefix_files: Vec<String>,
94    pub asns: Vec<i64>,
95    pub docs: Option<String>,
96    pub note: Option<String>,
97}