Struct bgpkit_parser::models::elem::BgpElem

pub struct BgpElem {

    pub timestamp: f64,
    pub elem_type: ElemType,
    pub peer_ip: IpAddr,
    pub peer_asn: Asn,
    pub prefix: NetworkPrefix,
    pub next_hop: Option<IpAddr>,
    pub as_path: Option<AsPath>,
    pub origin_asns: Option<Vec<Asn>>,
    pub origin: Option<Origin>,
    pub local_pref: Option<u32>,
    pub med: Option<u32>,
    pub communities: Option<Vec<MetaCommunity>>,
    pub atomic: bool,
    pub aggr_asn: Option<Asn>,
    pub aggr_ip: Option<BgpIdentifier>,
    pub only_to_customer: Option<Asn>,
    pub unknown: Option<Vec<AttrRaw>>,
    pub deprecated: Option<Vec<AttrRaw>>,
}

BgpElem represents a per-prefix BGP element.

This struct contains information about an announced/withdrawn prefix.

Fields:

• timestamp: The time when the BGP element was received.
• elem_type: The type of BGP element.
• peer_ip: The IP address of the BGP peer.
• peer_asn: The ASN of the BGP peer.
• prefix: The network prefix.
• next_hop: The next hop IP address.
• as_path: The AS path.
• origin_asns: The list of origin ASNs.
• origin: The origin attribute, i.e. IGP, EGP, or INCOMPLETE.
• local_pref: The local preference value.
• med: The multi-exit discriminator value.
• communities: The list of BGP communities.
• atomic: Flag indicating if the announcement is atomic.
• aggr_asn: The aggregated ASN.
• aggr_ip: The aggregated IP address.
• only_to_customer: The AS number to which the prefix is only announced.
• unknown: Unknown attributes formatted as (TYPE, RAW_BYTES).
• deprecated: Deprecated attributes formatted as (TYPE, RAW_BYTES).

Note: Constructing BGP elements consumes more memory due to duplicate information shared between multiple elements of one MRT record.

Fields

timestamp: f64

The timestamp of the item in floating-point format.

elem_type: ElemType

The element type of an item.

peer_ip: IpAddr

The IP address of the peer associated with the item.

peer_asn: Asn

The peer ASN (Autonomous System Number) of the item.

prefix: NetworkPrefix

The network prefix of the item.

next_hop: Option<IpAddr>

The next hop IP address for the item, if available.

as_path: Option<AsPath>

The optional path representation of the item.

This field is of type Option<AsPath>, which means it can either contain a value of type AsPath or be None.

origin_asns: Option<Vec<Asn>>

The origin ASNs associated with the prefix, if available.

Remarks

An Option type is used to indicate that the origin_asns field may or may not have a value. If it has a value, it will be a Vec (vector) of Asn objects representing the ASNs. If it does not have a value, it will be None.

origin: Option<Origin>

The origin of the item (IGP, EGP, INCOMPLETE), if known. Can be None if the origin is not available.

local_pref: Option<u32>

The local preference of the item, if available, represented as an option of unsigned 32-bit integer.

med: Option<u32>

The number of medical items in an option format.

communities: Option<Vec<MetaCommunity>>

A vector of optional MetaCommunity values.

Remarks

MetaCommunity represents a community metadata. The Option type indicates that the vector can be empty or contain MetaCommunity values. When the Option is Some, it means the vector is not empty and contains MetaCommunity values. When the Option is None, it means the vector is empty.

atomic: bool

Indicates whether the item is atomic aggreagte or not.

aggr_asn: Option<Asn>

The aggregated ASN of the item, represented as an optional Asn type.

aggr_ip: Option<BgpIdentifier>

The aggregated IP address of the item, represented as an optional BgpIdentifier, i.e. Ipv4Addr.

only_to_customer: Option<Asn>

unknown: Option<Vec<AttrRaw>>

unknown attributes formatted as (TYPE, RAW_BYTES)

deprecated: Option<Vec<AttrRaw>>

deprecated attributes formatted as (TYPE, RAW_BYTES)

Implementations

impl BgpElem

pub fn is_announcement(&self) -> bool

Returns true if the element is an announcement.

Most of the time, users do not really need to get the type out, only needs to know if it is an announcement or a withdrawal.

pub fn get_origin_asn_opt(&self) -> Option<u32>

Returns the origin AS number as u32. Returns None if the origin AS number is not present or it’s a AS set.

pub fn get_psv_header() -> String

Returns the PSV header as a string.

The PSV header is a pipe-separated string that represents the fields present in PSV (Prefix Statement Format) records. PSV records are used to describe BGP (Border Gateway Protocol) routing information.

Example

use bgpkit_parser::BgpElem;

let header = BgpElem::get_psv_header();
assert_eq!(header, "type|timestamp|peer_ip|peer_asn|prefix|as_path|origin_asns|origin|next_hop|local_pref|med|communities|atomic|aggr_asn|aggr_ip|only_to_customer");

pub fn to_psv(&self) -> String

Converts the struct fields into a pipe-separated values (PSV) formatted string.

Returns

Returns a String representing the struct fields in PSV format.

Example

use crate::bgpkit_parser::BgpElem;

let psv_string = BgpElem::default().to_psv();

println!("{}", psv_string);

Trait Implementations

impl Clone for BgpElem

fn clone(&self) -> BgpElem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BgpElem

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

Formats the value using the given formatter.

impl Default for BgpElem

fn default() -> Self

Returns the “default value” for a type.

impl Display for BgpElem

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

Formats the value using the given formatter.

impl Filterable for BgpElem

fn match_filter(&self, filter: &Filter) -> bool

fn match_filters(&self, filters: &[Filter]) -> bool

impl From<&BgpElem> for Attributes

fn from(value: &BgpElem) -> Self

Converts to this type from the input type.

impl From<&BgpElem> for BgpUpdateMessage

fn from(elem: &BgpElem) -> Self

Converts to this type from the input type.

impl Ord for BgpElem

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for BgpElem

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

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

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.

impl PartialOrd for BgpElem

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for BgpElem

impl StructuralPartialEq for BgpElem