Struct Elementor 

pub struct Elementor {
    pub peer_table: Option<PeerIndexTable>,
}

Fields

peer_table: Option<PeerIndexTable>

Implementations

impl Elementor

pub fn new() -> Elementor

pub fn set_peer_table(&mut self, record: MrtRecord) -> Result<(), ParserError>

Sets the peer index table for the elementor.

This method takes an MRT record and extracts the peer index table from it if the record contains one. The peer index table is required for processing TableDumpV2 records, as it contains the mapping between peer indices and their corresponding IP addresses and ASNs.

Arguments

• record - An MRT record that should contain a peer index table

Returns

• Ok(()) - If the peer table was successfully extracted and set
• Err(ParserError) - If the record does not contain a peer index table

Example

use bgpkit_parser::{BgpkitParser, Elementor};

let mut parser = BgpkitParser::new("rib.dump.bz2").unwrap();
let mut elementor = Elementor::new();

// Get the first record which should be the peer index table
if let Ok(record) = parser.next_record() {
    elementor.set_peer_table(record).unwrap();
}

pub fn with_peer_table(peer_table: PeerIndexTable) -> Elementor

Creates an Elementor with the given PeerIndexTable already set.

pub fn record_to_elems_iter( &self, record: MrtRecord, ) -> Result<RecordElemIter<'_>, ElemError>

Convert a MrtRecord into an iterator of BgpElems without requiring &mut self.

Unlike record_to_elems, this method:

• Takes &self instead of &mut self, since the peer table must already be set via set_peer_table or with_peer_table.
• Returns an error if the record contains a PeerIndexTable (which would require mutation).
• Returns a lazy RecordElemIter instead of collecting into a Vec, avoiding allocation for the common RIB table dump case.

Errors

• ElemError::UnexpectedPeerIndexTable if the record is a PeerIndexTable message.
• ElemError::MissingPeerTable if the record requires a peer table but none is set.

pub fn bgp_to_elems( msg: BgpMessage, timestamp: f64, peer_ip: &IpAddr, peer_asn: &Asn, ) -> Vec<BgpElem>

Convert a BgpMessage to a vector of BgpElems.

A BgpMessage may include Update, Open, Notification or KeepAlive messages, and only Update message contains BgpElems.

pub fn bgp_to_elems_iter( msg: BgpMessage, timestamp: f64, peer_ip: &IpAddr, peer_asn: &Asn, ) -> Option<BgpUpdateElemIter>

Convert a BgpMessage into an iterator of BgpElems.

Returns None for non-Update messages (Open, Notification, KeepAlive).

pub fn bgp_update_to_elems( msg: BgpUpdateMessage, timestamp: f64, peer_ip: &IpAddr, peer_asn: &Asn, ) -> Vec<BgpElem>

Convert a BgpUpdateMessage to a vector of BgpElems.

pub fn bgp_update_to_elems_iter( msg: BgpUpdateMessage, timestamp: f64, peer_ip: &IpAddr, peer_asn: &Asn, ) -> BgpUpdateElemIter

Convert a BgpUpdateMessage into a BgpUpdateElemIter that lazily yields BgpElems without allocating a Vec.

pub fn record_to_elems(&mut self, record: MrtRecord) -> Vec<BgpElem>

Convert a MrtRecord to a vector of BgpElems.

If the record is a PeerIndexTable, it is consumed to set the internal peer table. Errors are logged.

For a non-mutating, lazy alternative, see record_to_elems_iter.

Trait Implementations

impl Clone for Elementor

fn clone(&self) -> Elementor

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Elementor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Elementor

fn default() -> Elementor

Returns the “default value” for a type.