Struct bgpkit_parser::models::PeerIndexTable

source ·
pub struct PeerIndexTable {
    pub collector_bgp_id: BgpIdentifier,
    pub view_name: String,
    pub id_peer_map: HashMap<u16, Peer>,
    pub peer_addr_id_map: HashMap<IpAddr, u16>,
}
Expand description

peer index table.

   An initial PEER_INDEX_TABLE MRT record provides the BGP ID of the
   collector, an OPTIONAL view name, and a list of indexed peers.
   Following the PEER_INDEX_TABLE MRT record, a series of MRT records is
   used to encode RIB table entries.  This series of MRT records uses
   subtypes 2-6 and is separate from the PEER_INDEX_TABLE MRT record
   itself and includes full MRT record headers.  The RIB entry MRT
   records MUST immediately follow the PEER_INDEX_TABLE MRT record.

Fields§

§collector_bgp_id: BgpIdentifier§view_name: String§id_peer_map: HashMap<u16, Peer>§peer_addr_id_map: HashMap<IpAddr, u16>

Implementations§

source§

impl PeerIndexTable

source

pub fn add_peer(&mut self, peer: Peer) -> u16

Add peer to peer index table and return peer id

source

pub fn get_peer_by_id(&self, peer_id: &u16) -> Option<&Peer>

Returns the peer associated with the given peer ID.

§Arguments
  • peer_id - A reference to the peer ID.
§Returns

An Option containing a reference to the Peer if found, otherwise None.

source

pub fn get_peer_id_by_addr(&self, peer_addr: &IpAddr) -> Option<u16>

Returns the peer ID associated with the given IP address.

§Arguments
  • peer_addr - The IP address of the peer.
§Returns

An optional u16 representing the peer ID. Returns None if the IP address is not found.

§Examples
use std::net::IpAddr;
use std::str::FromStr;
use bgpkit_parser::models::PeerIndexTable;

let index_table = PeerIndexTable::default();
let peer_addr = IpAddr::from_str("127.0.0.1").unwrap();
let peer_id = index_table.get_peer_id_by_addr(&peer_addr);
source

pub fn encode(&self) -> Bytes

Encode the data in the struct into a byte array.

§Returns

A Bytes object containing the encoded data.

§Example
use std::collections::HashMap;
use std::net::Ipv4Addr;
use bgpkit_parser::models::PeerIndexTable;

let data = PeerIndexTable {
    collector_bgp_id: Ipv4Addr::from(1234),
    view_name: String::from("example"),
    id_peer_map: HashMap::new(),
    peer_addr_id_map: Default::default(),
};

let encoded = data.encode();

Trait Implementations§

source§

impl Clone for PeerIndexTable

source§

fn clone(&self) -> PeerIndexTable

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for PeerIndexTable

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for PeerIndexTable

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl PartialEq for PeerIndexTable

source§

fn eq(&self, other: &PeerIndexTable) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Eq for PeerIndexTable

source§

impl StructuralPartialEq for PeerIndexTable

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more