Enum Capability 

pub enum Capability {
    MultiProtocol {
        afi: Afi,
        safi: Safi,
    },
    ExtendedNextHop(Vec<ExtendedNextHopFamily>),
    GracefulRestart {
        restart_state: bool,
        notification: bool,
        restart_time: u16,
        families: Vec<GracefulRestartFamily>,
    },
    RouteRefresh,
    EnhancedRouteRefresh,
    ExtendedMessage,
    LongLivedGracefulRestart(Vec<LlgrFamily>),
    AddPath(Vec<AddPathFamily>),
    OutboundRouteFilter(Vec<OrfCapEntry>),
    FourOctetAs {
        asn: u32,
    },
    Role {
        role: BgpRole,
    },
    Unknown {
        code: u8,
        data: Bytes,
    },
}

BGP capability as negotiated in OPEN optional parameters.

Variants

MultiProtocol

RFC 4760: Multi-Protocol Extensions.

Fields

afi: Afi

Address family.

safi: Safi

Sub-address family.

ExtendedNextHop(Vec<ExtendedNextHopFamily>)

RFC 8950: Extended Next Hop Encoding.

GracefulRestart

RFC 4724: Graceful Restart.

Fields

restart_state: bool

R-bit: the sender has restarted and its forwarding state may have been preserved.

notification: bool

N-bit (RFC 8538): the sender supports Notification GR — NOTIFICATIONs trigger GR unless Cease/Hard Reset (subcode 9) is used.

restart_time: u16

Time in seconds the sender will retain stale routes (12-bit, max 4095).

families: Vec<GracefulRestartFamily>

Per-AFI/SAFI forwarding state flags.

RouteRefresh

RFC 2918: Route Refresh.

EnhancedRouteRefresh

RFC 7313: Enhanced Route Refresh.

ExtendedMessage

RFC 8654: Extended Messages (raise max message length to 65535).

LongLivedGracefulRestart(Vec<LlgrFamily>)

RFC 9494: Long-Lived Graceful Restart.

AddPath(Vec<AddPathFamily>)

RFC 7911: Add-Path — advertise/receive multiple paths per prefix.

OutboundRouteFilter(Vec<OrfCapEntry>)

RFC 5291: Outbound Route Filtering — per-family ORF-Type/role blocks.

FourOctetAs

RFC 6793: 4-Byte AS Number.

Fields

asn: u32

The 4-byte autonomous system number.

Role

RFC 9234 §4: BGP Role. The speaker’s role on this eBGP session.

Fields

role: BgpRole

The role advertised by this speaker.

Unknown

Unknown or unrecognized capability, preserved for re-emission.

Fields

code: u8

Capability code.

data: Bytes

Raw capability value bytes.

Implementations

impl Capability

pub fn decode(buf: &mut impl Buf) -> Result<Self, DecodeError>

Decode a single capability TLV from a buffer.

Errors

Returns DecodeError::MalformedOptionalParameter if the TLV is truncated or the claimed length exceeds the remaining bytes.

pub fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

Encode a single capability TLV into a buffer.

Errors

Returns EncodeError::ValueOutOfRange if the capability value exceeds the 255-byte limit of the single-octet length field.

pub fn code(&self) -> u8

Returns the capability code byte.

pub fn encoded_len(&self) -> usize

Encoded size of this capability TLV (code + length + value).

Trait Implementations

impl Clone for Capability

fn clone(&self) -> Capability

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Capability

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

Formats the value using the given formatter.

impl Eq for Capability

impl PartialEq for Capability

fn eq(&self, other: &Capability) -> 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 StructuralPartialEq for Capability