Skip to main content

AttributeValue

Enum AttributeValue 

Source
pub enum AttributeValue {
Show 31 variants Origin(Origin), AsPath(AsPath), As4Path(AsPath), NextHop(IpAddr), MultiExitDiscriminator(u32), LocalPreference(u32), OnlyToCustomer(Asn), AtomicAggregate, Aggregator { asn: Asn, id: BgpIdentifier, }, As4Aggregator { asn: Asn, id: BgpIdentifier, }, Communities(Vec<Community>), ExtendedCommunities(Vec<ExtendedCommunity>), Ipv6AddressSpecificExtendedCommunities(Vec<Ipv6AddrExtCommunity>), LargeCommunities(Vec<LargeCommunity>), OriginatorId(BgpIdentifier), Clusters(Vec<u32>), MpReachNlri(Nlri), MpUnreachNlri(Nlri), LinkState(LinkStateAttribute), TunnelEncapsulation(TunnelEncapAttribute), TrafficEngineering(TrafficEngineering), BfdDiscriminator(BfdDiscriminatorAttribute), BgpPrefixSid(BgpPrefixSidAttribute), Bier(BierAttribute), Sfp(SfpAttribute), Development(Vec<u8>), Raw(AttrRaw), Deprecated(AttrRaw), Unknown(AttrRaw), Aigp(Aigp), AttrSet(AttrSet),
}
Expand description

The AttributeValue enum represents different kinds of Attribute values.

Serde (and therefore the WASM JSON output) uses default external tagging: data-carrying variants serialize as { "<VariantName>": payload }, while unit variants (e.g. AtomicAggregate) serialize as the bare string "<VariantName>".

Long-tail variants (LinkState, TunnelEncapsulation, …) are typed as opaque Record<string, unknown> in the generated TypeScript; the common variants are fully typed. AsPath/As4Path payloads have a custom serde encoding (flat array of ASNs, nested arrays for AS_SETs), inlined here.

Variants§

§

Origin(Origin)

§

AsPath(AsPath)

AS_PATH (type 2), RFC 4271 §4.3.

On encode, the segment width follows the session’s asn_len passed to Attribute::encode_to: a 4-octet session encodes 4-octet AS numbers directly. This is the variant to use when building announcements.

§

As4Path(AsPath)

AS4_PATH (type 17), RFC 6793 §4.2 — the migration fallback that carries the full path with 4-octet AS numbers alongside a 2-octet AS_PATH.

Segments always encode as 4-octet regardless of the session’s asn_len. Only speakers sending 4-octet AS numbers over a 2-octet session should emit this attribute; RFC 6793 §4.1 forbids it on 4-octet sessions.

§

NextHop(IpAddr)

§

MultiExitDiscriminator(u32)

§

LocalPreference(u32)

§

OnlyToCustomer(Asn)

§

AtomicAggregate

§

Aggregator

AGGREGATOR (type 7), RFC 4271 §4.3.8.

On encode, the AS number width follows the session’s asn_len.

Fields

§asn: Asn
§

As4Aggregator

AS4_AGGREGATOR (type 18), RFC 6793 — carries the aggregator AS number as 4 octets alongside a 2-octet AGGREGATOR. Always encodes the AS number as 4 octets.

Fields

§asn: Asn
§

Communities(Vec<Community>)

§

ExtendedCommunities(Vec<ExtendedCommunity>)

§

Ipv6AddressSpecificExtendedCommunities(Vec<Ipv6AddrExtCommunity>)

§

LargeCommunities(Vec<LargeCommunity>)

§

OriginatorId(BgpIdentifier)

§

Clusters(Vec<u32>)

§

MpReachNlri(Nlri)

§

MpUnreachNlri(Nlri)

§

LinkState(LinkStateAttribute)

BGP Link-State attribute - RFC 7752

§

TunnelEncapsulation(TunnelEncapAttribute)

BGP Tunnel Encapsulation attribute - RFC 9012

§

TrafficEngineering(TrafficEngineering)

BGP Traffic Engineering attribute - RFC 5543

§

BfdDiscriminator(BfdDiscriminatorAttribute)

BFD Discriminator attribute - RFC 9026

§

BgpPrefixSid(BgpPrefixSidAttribute)

BGP Prefix-SID attribute - RFC 8669

§

Bier(BierAttribute)

BIER attribute - RFC 9793

§

Sfp(SfpAttribute)

SFP attribute - RFC 9015

§

Development(Vec<u8>)

§

Raw(AttrRaw)

§

Deprecated(AttrRaw)

§

Unknown(AttrRaw)

§

Aigp(Aigp)

AIGP (Accumulated IGP Metric) attribute - RFC 7311

§

AttrSet(AttrSet)

ATTR_SET attribute - RFC 6368

Implementations§

Source§

impl AttributeValue

Source

pub fn attr_type(&self) -> AttrType

Source

pub fn attr_code(&self) -> u8

Source

pub fn attr_category(&self) -> Option<AttributeCategory>

Source

pub fn default_flags(&self) -> AttrFlags

Get flags based on the attribute type. The AttrFlags::EXTENDED is not taken into account when determining the correct flags.

Trait Implementations§

Source§

impl Clone for AttributeValue

Source§

fn clone(&self) -> AttributeValue

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AttributeValue

Source§

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

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

impl Eq for AttributeValue

Source§

impl Extend<AttributeValue> for Attributes

Source§

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

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

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. Read more
Source§

impl From<AsPath> for AttributeValue

Converts to the AS_PATH (type 2) attribute value. Use AttributeValue::As4Path explicitly to build the RFC 6793 migration-fallback attribute.

Source§

fn from(path: AsPath) -> Self

Converts to this type from the input type.
Source§

impl From<AttributeValue> for Attribute

Source§

fn from(value: AttributeValue) -> Self

Converts to this type from the input type.
Source§

impl From<Origin> for AttributeValue

Source§

fn from(value: Origin) -> Self

Converts to this type from the input type.
Source§

impl FromIterator<AttributeValue> for Attributes

Source§

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

Creates a value from an iterator. Read more
Source§

impl PartialEq for AttributeValue

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for AttributeValue

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ErasedDestructor for T
where T: 'static,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> MaybeSendSync for T

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

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>,

Source§

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>,

Source§

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