Struct UpdateMessage 

pub struct UpdateMessage {
    pub withdrawn_routes: Bytes,
    pub path_attributes: Bytes,
    pub nlri: Bytes,
}

A decoded BGP UPDATE message (RFC 4271 §4.3).

Stores the three variable-length sections as raw Bytes. Call parse() to decode NLRI and path attributes.

Fields

withdrawn_routes: Bytes

Raw withdrawn routes (NLRI encoding).

path_attributes: Bytes

Raw path attributes.

nlri: Bytes

Raw Network Layer Reachability Information.

Implementations

impl UpdateMessage

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

Decode an UPDATE message body from a buffer. The header must already be consumed; body_len is header.length - HEADER_LEN.

Errors

Returns DecodeError::UpdateLengthMismatch if the body is too short or length fields are inconsistent, or DecodeError::Incomplete if the buffer has fewer bytes than body_len.

pub fn parse( &self, four_octet_as: bool, add_path_ipv4: bool, add_path_families: &[(Afi, Safi)], ) -> Result<ParsedUpdate, DecodeError>

Parse the raw UPDATE into decoded prefixes and path attributes.

four_octet_as controls whether AS numbers in AS_PATH are 2 or 4 bytes wide (determined by capability negotiation).

add_path_ipv4 indicates whether the peer is sending Add-Path path IDs for IPv4 body NLRI (RFC 7911). When false, decoded entries have path_id = 0.

Errors

Returns DecodeError if NLRI or attribute data is malformed.

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

Encode a complete UPDATE message (header + body) into a buffer.

max_message_len is the negotiated maximum: 4096 normally, or 65535 when Extended Messages (RFC 8654) has been negotiated.

Errors

Returns EncodeError::MessageTooLong if the encoded message exceeds the negotiated maximum message size.

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

Encode using the standard 4096-byte limit.

Errors

Returns EncodeError::MessageTooLong if the encoded message exceeds the standard 4096-byte maximum.

pub fn build( announced: &[Ipv4NlriEntry], withdrawn: &[Ipv4NlriEntry], attributes: &[PathAttribute], four_octet_as: bool, add_path: bool, ipv4_unicast_mode: Ipv4UnicastMode, ) -> Self

Build an UpdateMessage from structured data.

Encodes NLRI, withdrawn routes, and path attributes into the raw Bytes fields that encode() expects.

When add_path is true, path IDs are included in the wire encoding. When false, only the prefix is encoded (path IDs are ignored).

pub fn encoded_len(&self) -> usize

Total encoded size in bytes.

Trait Implementations

impl Clone for UpdateMessage

fn clone(&self) -> UpdateMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateMessage

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

Formats the value using the given formatter.

impl Eq for UpdateMessage

impl PartialEq for UpdateMessage

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