monocle 1.2.0

A commandline application to search, parse, and process BGP information in public sources.
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
67
68
69

//! Query helper types (non-core protocol).
//!
//! This module intentionally contains types that are useful for *future* query/streaming
//! methods (e.g. `parse.*`, `search.*`) but are not part of the minimal stable core
//! WebSocket protocol envelope.
//!
//! Rationale:
//! - Keep `protocol.rs` focused on the stable envelope + shared error/progress vocabulary.
//! - Avoid accidental scope creep in the core protocol surface area.
//!
//! These types are purely data containers and should remain network-neutral.

use serde::{Deserialize, Serialize};

/// Pagination parameters for list/query methods.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct Pagination {
    /// Maximum number of results to return (clamped to server max, if any).
    #[serde(default)]
    pub limit: Option<u32>,

    /// Offset for pagination (non-negative).
    #[serde(default)]
    pub offset: Option<u32>,
}

/// Query filters shared by future streaming operations (e.g. `parse.start`, `search.start`).
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct QueryFilters {
    /// Filter by origin ASN.
    #[serde(default)]
    pub origin_asn: Option<u32>,

    /// Filter by prefix.
    #[serde(default)]
    pub prefix: Option<String>,

    /// Include super-prefixes.
    #[serde(default)]
    pub include_super: Option<bool>,

    /// Include sub-prefixes.
    #[serde(default)]
    pub include_sub: Option<bool>,

    /// Filter by peer IPs.
    #[serde(default)]
    pub peer_ip: Vec<String>,

    /// Filter by peer ASN.
    #[serde(default)]
    pub peer_asn: Option<u32>,

    /// Filter by element type (announce/withdraw).
    #[serde(default)]
    pub elem_type: Option<String>,

    /// Start timestamp (RFC3339 or Unix).
    #[serde(default)]
    pub start_ts: Option<String>,

    /// End timestamp (RFC3339 or Unix).
    #[serde(default)]
    pub end_ts: Option<String>,

    /// Filter by AS path regex.
    #[serde(default)]
    pub as_path: Option<String>,
}