Struct Attributes 

pub struct Attributes { /* private fields */ }

Convenience wrapper for a list of attributes

Implementations

impl Attributes

pub fn has_attr(&self, ty: AttrType) -> bool

pub fn get_attr(&self, ty: AttrType) -> Option<Attribute>

pub fn add_attr(&mut self, attr: Attribute)

pub fn check_mandatory_attributes( &mut self, is_announcement: bool, has_standard_nlri: bool, )

Check for missing well-known mandatory attributes.

RFC 4271 (BGP-4) and RFC 4760 (MP-BGP) define which attributes are mandatory.

• Pure Withdrawals: NO path attributes are required.
• Announcements: ORIGIN and AS_PATH are strictly required.
• NEXT_HOP is required if standard IPv4 NLRI is present or if no MP_REACH_NLRI is present.

pub fn add_validation_warning(&mut self, warning: BgpValidationWarning)

Add a validation warning to the attributes

pub fn validation_warnings(&self) -> &[BgpValidationWarning]

Get all validation warnings for these attributes

pub fn has_validation_warnings(&self) -> bool

Check if there are any validation warnings

pub fn origin(&self) -> Origin

Get the ORIGIN attribute. In the event that this attribute is not present, Origin::INCOMPLETE will be returned instead.

pub fn origin_id(&self) -> Option<BgpIdentifier>

Get the ORIGINATOR_ID attribute if present.

pub fn next_hop(&self) -> Option<IpAddr>

Get the NEXT_HOP attribute if present.

Note: Even when this attribute is not present, the next hop address may still be attainable from the MP_REACH_NLRI attribute.

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

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

pub fn only_to_customer(&self) -> Option<Asn>

pub fn atomic_aggregate(&self) -> bool

pub fn aggregator(&self) -> Option<(Asn, BgpIdentifier)>

pub fn clusters(&self) -> Option<&[u32]>

pub fn as_path(&self) -> Option<&AsPath>

Get the AS_PATH (type 2) attribute value, without merging a coexisting AS4_PATH. See Attributes::effective_as_path for the RFC 6793 merged path.

pub fn as4_path(&self) -> Option<&AsPath>

Get the AS4_PATH (type 17) attribute value if present.

pub fn effective_as_path(&self) -> Option<AsPath>

Get the effective AS path per RFC 6793 §4.2.3.

When both AS_PATH and AS4_PATH are present (a 2-octet session carrying 4-octet AS numbers), the two are merged: the leading ASes come from the 2-octet AS_PATH and the trailing ASes from the 4-octet AS4_PATH. Otherwise whichever attribute is present is returned as-is.

pub fn get_reachable_nlri(&self) -> Option<&Nlri>

pub fn get_unreachable_nlri(&self) -> Option<&Nlri>

pub fn iter_communities(&self) -> MetaCommunitiesIter<'_>

pub fn iter(&self) -> <&Self as IntoIterator>::IntoIter

Get an iterator over the held AttributeValues. If you also need attribute flags, consider using Attributes::into_attributes_iter instead.

pub fn into_attributes_iter(self) -> impl Iterator<Item = Attribute>

Get an iterator over the held Attributes. If you do no not need attribute flags, consider using Attributes::iter instead.

impl Attributes

pub fn encode_to( &self, asn_len: AsnLength, buf: &mut BytesMut, ) -> Result<(), EncodingError>

Append the wire representation of all attributes to buf.

pub fn encode(&self, asn_len: AsnLength) -> Result<Bytes, EncodingError>

Encode all attributes into a fresh buffer.

Trait Implementations

impl Clone for Attributes

fn clone(&self) -> Attributes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Attributes

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

Formats the value using the given formatter.

impl Default for Attributes

fn default() -> Attributes

Returns the “default value” for a type.

impl Eq for Attributes

impl Extend<Attribute> for Attributes

fn extend<T: IntoIterator<Item = Attribute>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<AttributeValue> for Attributes

fn extend<T: IntoIterator<Item = AttributeValue>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<&BgpElem> for Attributes

fn from(value: &BgpElem) -> Self

Converts to this type from the input type.

impl From<Vec<Attribute>> for Attributes

fn from(value: Vec<Attribute>) -> Self

Converts to this type from the input type.

impl FromIterator<Attribute> for Attributes

fn from_iter<T: IntoIterator<Item = Attribute>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<AttributeValue> for Attributes

fn from_iter<T: IntoIterator<Item = AttributeValue>>(iter: T) -> Self

Creates a value from an iterator.

impl IntoIterator for Attributes

type Item = AttributeValue

The type of the elements being iterated over.

type IntoIter = Map<IntoIter<Attribute>, fn(Attribute) -> AttributeValue>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a Attributes

type Item = &'a AttributeValue

The type of the elements being iterated over.

type IntoIter = Map<Iter<'a, Attribute>, fn(&Attribute) -> &AttributeValue>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Attributes

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Attributes