Struct ExtendedCommunity 

pub struct ExtendedCommunity(/* private fields */);

RFC 4360 Extended Community — 8-byte value stored as u64.

Wire layout: type (1) + sub-type (1) + value (6). Bit 6 of the type byte: 0 = transitive, 1 = non-transitive.

Implementations

impl ExtendedCommunity

pub fn new(raw: u64) -> Self

Create from a raw 8-byte value.

pub fn as_u64(self) -> u64

Return the raw 8-byte value.

pub fn type_byte(self) -> u8

High byte — IANA-assigned type.

pub fn subtype(self) -> u8

Second byte — sub-type within the type.

pub fn is_transitive(self) -> bool

Transitive if bit 6 of the type byte is 0.

pub fn value_bytes(self) -> [u8; 6]

Bytes 2-7 of the community value.

pub fn route_target(self) -> Option<(u32, u32)>

Decode as Route Target (sub-type 0x02).

Returns (global_admin, local_admin) as raw u32 values. The interpretation of global_admin depends on the type byte:

• Type 0x00 (2-octet AS specific): global = ASN (fits u16), local = u32
• Type 0x01 (IPv4 address specific): global = IPv4 addr as u32, local = u16
• Type 0x02 (4-octet AS specific): global = ASN (u32), local = u16

Callers that need to distinguish these encodings (e.g. for display as RT:192.0.2.1:100 vs RT:65001:100) must also check type_byte().

pub fn route_origin(self) -> Option<(u32, u32)>

Decode as Route Origin (sub-type 0x03).

Same layout as route_target() — returns raw (global_admin, local_admin) with the same type-byte-dependent interpretation. Check type_byte() to distinguish 2-octet AS, IPv4-address, and 4-octet AS encodings.

pub fn as_bgp_encapsulation(self) -> Option<u16>

Decode as BGP Encapsulation Extended Community (RFC 9012 §4.1, encoded per the widely-deployed RFC 5512 layout: 4-byte reserved + 2-byte Tunnel Type). Type 0x03, subtype 0x0C.

Returns the Tunnel Type code. For VXLAN-EVPN (RFC 8365), the value is 8. Other common values: 7 = NVGRE, 11 = MPLS-over-GRE.

The reserved bytes are intentionally not validated here: RFC 5512 specifies MUST-zero on send, ignored on receive. FRR, GoBGP, Cisco, and Juniper all emit zeros in practice; rejecting non-zero reserves would break interop in the rare case an unknown implementation re-purposes those bytes. Consumers should treat the returned tunnel_type as the semantic signal.

pub fn bgp_encapsulation(tunnel_type: u16) -> Self

Construct a BGP Encapsulation Extended Community (RFC 9012 §4.1).

Writes 4 bytes of reserved zero followed by the 16-bit tunnel type.

pub fn as_mac_mobility(self) -> Option<(bool, u32)>

Decode as MAC Mobility Extended Community (RFC 7432 §7.7). Type 0x06, subtype 0x00.

Returns (sticky, sequence_number). The sticky bit (bit 0 of the flags byte) marks the MAC as non-movable; receivers must not displace a sticky MAC with a higher-sequence non-sticky advertisement.

pub fn mac_mobility(sticky: bool, sequence: u32) -> Self

Construct a MAC Mobility Extended Community (RFC 7432 §7.7).

pub fn as_esi_label(self) -> Option<(bool, u32)>

Decode as ESI Label Extended Community (RFC 7432 §7.5). Type 0x06, subtype 0x01.

Returns (single_active, label). The single-active flag (bit 0 of the flags byte) signals single-active multi-homing mode.

pub fn esi_label(single_active: bool, label: u32) -> Self

Construct an ESI Label Extended Community (RFC 7432 §7.5).

label is a 24-bit MPLS label or VXLAN VNI; high 8 bits are masked.

pub fn as_es_import_rt(self) -> Option<[u8; 6]>

Decode as ES-Import Route Target Extended Community (RFC 7432 §7.6). Type 0x06, subtype 0x02.

Returns the 6-byte MAC address that serves as the import target for Type 4 ES routes.

pub fn es_import_rt(mac: [u8; 6]) -> Self

Construct an ES-Import Route Target Extended Community.

pub fn as_df_election(self) -> Option<DfElectionExtendedCommunity>

Decode as DF Election Extended Community (RFC 8584 §2.2, updated by RFC 9785 §3). Type 0x06, subtype 0x06.

pub fn df_election( algorithm_id: u8, capabilities: u16, preference: Option<u16>, ) -> Self

Construct a DF Election Extended Community (RFC 8584 §2.2, RFC 9785 §3).

algorithm_id is masked to the five-bit DF Alg field. For DefaultModulo and HRW, pass None for preference so the reserved trailing bytes are emitted as zero.

pub fn as_router_mac(self) -> Option<[u8; 6]>

Decode as Router MAC Extended Community (RFC 9135 §4.1). Type 0x06, subtype 0x03.

Returns the 6-byte router MAC used for symmetric IRB.

pub fn router_mac(mac: [u8; 6]) -> Self

Construct a Router MAC Extended Community (RFC 9135 §4.1).

pub fn as_default_gateway(self) -> bool

Decode as Default Gateway Extended Community (RFC 4761 §3.2.5 / RFC 7432). Type 0x03, subtype 0x0D. This is a flag-only community: presence is the signal and the 6-byte value field must be all zeros. Malformed advertisements with non-zero value bytes are treated as non-matches rather than silently accepted — downstream policy and validation consumers treat this accessor as semantic truth.

pub fn default_gateway() -> Self

Construct a Default Gateway Extended Community.

impl ExtendedCommunity

pub fn as_flowspec_action(&self) -> Option<FlowSpecAction>

Try to decode this extended community as a FlowSpec action.

pub fn from_flowspec_action(action: &FlowSpecAction) -> Self

Create an extended community from a FlowSpec action.

Trait Implementations

impl Clone for ExtendedCommunity

fn clone(&self) -> ExtendedCommunity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExtendedCommunity

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

Formats the value using the given formatter.

impl Display for ExtendedCommunity

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

Formats the value using the given formatter.

impl Hash for ExtendedCommunity

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ExtendedCommunity

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ExtendedCommunity

impl Eq for ExtendedCommunity

impl StructuralPartialEq for ExtendedCommunity