bgpkit-parser 0.9.0-alpha-2

A library to parse MRT/BGP/BMP binary 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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

use std::io::BufRead;

#[macro_use]
pub mod utils;
pub mod mrt;
pub mod bmp;
pub mod bgp;
pub mod iters;
pub mod rislive;
pub mod filter;

pub(crate) use self::utils::*;
pub(crate) use bgp::attributes::AttributeParser;
pub(crate) use mrt::{parse_bgp4mp, parse_table_dump_message, parse_table_dump_v2_message, parse_mrt_record};

pub use crate::error::{ParserErrorWithBytes, ParserError};
pub use mrt::mrt_elem::Elementor;
use bgp_models::prelude::{ElemType, MrtRecord};
use oneio::get_reader;
use crate::Filter;

pub struct BgpkitParser {
    reader: Box<dyn BufRead>,
    core_dump: bool,
    filters: Vec<Filter>,
    options: ParserOptions
}

pub(crate) struct ParserOptions {
    show_warnings: bool
}
impl Default for ParserOptions {
    fn default() -> Self {
        ParserOptions{
            show_warnings: true
        }
    }
}

unsafe impl Send for BgpkitParser {}

impl BgpkitParser {
    /// Creating a new parser from a object that implements [Read] trait.
    pub fn new(path: &str) -> Result<BgpkitParser, ParserErrorWithBytes>{
        let reader = get_reader(path)?;
        Ok(
            BgpkitParser{
                reader,
                core_dump: false,
                filters: vec![],
                options: ParserOptions::default()
            }
        )
    }

    pub fn enable_core_dump(self) -> BgpkitParser {
        BgpkitParser{
            reader: self.reader,
            core_dump: true,
            filters: self.filters,
            options: self.options
        }
    }

    pub fn disable_warnings(self) -> BgpkitParser {
        let mut options = self.options;
        options.show_warnings = false;
        BgpkitParser{
            reader: self.reader,
            core_dump: self.core_dump,
            filters: self.filters,
            options
        }
    }

    pub fn add_filter(self, filter_type: &str, filter_value: &str) -> Result<BgpkitParser, ParserErrorWithBytes> {
        let mut filters = self.filters;
        filters.push(Filter::new(filter_type, filter_value)?);
        Ok(
            BgpkitParser {
                reader: self.reader,
                core_dump: self.core_dump,
                filters,
                options: self.options
            }
        )
    }

    /// This is used in for loop `for item in parser{}`
    pub fn next_record(&mut self) -> Result<MrtRecord, ParserErrorWithBytes> {
        parse_mrt_record(&mut self.reader)
    }
}