Struct RouteRefreshMessage 

pub struct RouteRefreshMessage {
    pub afi_raw: u16,
    pub subtype_raw: u8,
    pub safi_raw: u8,
    pub orf: Option<OrfPayload>,
}

BGP ROUTE-REFRESH message (RFC 2918 + RFC 7313 + RFC 5291 ORF).

Requests a peer to re-advertise its Adj-RIB-Out for the specified address family. RFC 7313 reuses the third octet as a demarcation subtype (BoRR/EoRR). Raw wire values are stored so that unknown AFI/SAFI or subtype values can be decoded without error — the transport layer decides whether to act on or ignore them.

When the message body extends beyond the 4-byte AFI/Reserved/SAFI header, the trailing bytes are an RFC 5291 ORF section, decoded into orf. A plain or Enhanced Route Refresh has orf set to None.

Fields

afi_raw: u16

Raw AFI value from the wire.

subtype_raw: u8

Raw demarcation subtype byte from the wire.

safi_raw: u8

Raw SAFI value from the wire.

orf: Option<OrfPayload>

RFC 5291 ORF section, present when the body extends past the 4-byte header. None for a plain (RFC 2918) or Enhanced (RFC 7313) refresh.

Implementations

impl RouteRefreshMessage

pub fn new(afi: Afi, safi: Safi) -> Self

Create a normal (subtype 0) ROUTE-REFRESH from typed AFI/SAFI values.

pub fn new_with_subtype( afi: Afi, safi: Safi, subtype: RouteRefreshSubtype, ) -> Self

Create a ROUTE-REFRESH with an explicit subtype.

pub fn new_with_orf(afi: Afi, safi: Safi, orf: OrfPayload) -> Self

Create an ORF-carrying ROUTE-REFRESH (RFC 5291 §5.2). The third octet is Reserved (subtype 0) for an ORF message.

pub fn afi(&self) -> Option<Afi>

Try to interpret the raw AFI as a known address family.

pub fn safi(&self) -> Option<Safi>

Try to interpret the raw SAFI as a known sub-address family.

pub fn subtype(&self) -> RouteRefreshSubtype

Decode the demarcation subtype.

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

Decode a ROUTE-REFRESH message body from a buffer.

A 4-byte body is a plain/Enhanced refresh (orf: None). A longer body carries an RFC 5291 ORF section, decoded into orf. A malformed ORF entry does not fail the decode — it is surfaced via crate::orf::OrfEntries::Malformed so the caller can apply the RFC 5291 §5.2 reset semantics instead of tearing the session down.

Errors

Returns DecodeError if the body length is below 4 or the buffer is truncated relative to the declared body length. Unknown AFI/SAFI values and unknown subtypes are preserved.

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

Encode a complete ROUTE-REFRESH message (header + body) into a buffer.

Errors

Returns EncodeError if the total message length (with an ORF section) exceeds the 16-bit length field.

pub fn encoded_len(&self) -> usize

Total encoded size on the wire (header + base body + any ORF section).

Trait Implementations

impl Clone for RouteRefreshMessage

fn clone(&self) -> RouteRefreshMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RouteRefreshMessage

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

Formats the value using the given formatter.

impl Display for RouteRefreshMessage

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

Formats the value using the given formatter.

impl Eq for RouteRefreshMessage

impl PartialEq for RouteRefreshMessage

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