Struct rpki_rtr::pdu::Ipv4Prefix

#[repr(packed)]
pub struct Ipv4Prefix { /* private fields */ }

An IPv4 prefix is the payload PDU for route origin authorisation in IPv4.

Implementations

impl Ipv4Prefix

pub const PDU: u8 = 4u8

The payload type of an IPv4 prefix.

pub fn new(
    version: u8,
    flags: u8,
    prefix_len: u8,
    max_len: u8,
    prefix: Ipv4Addr,
    asn: u32
) -> Self

Creates a new IPv4 prefix from all the various fields.

pub fn flags(&self) -> u8

Returns the flags field of the prefix.

The only flag currently used is the least significant but that is 1 for an announcement and 0 for a withdrawal.

pub fn prefix_len(&self) -> u8

Returns the prefix length.

pub fn max_len(&self) -> u8

Returns the max length.

pub fn prefix(&self) -> Ipv4Addr

Returns the prefix as IPv4 address.

pub fn asn(&self) -> u32

Returns the autonomous system number.

impl Ipv4Prefix

pub async fn write<A: AsyncWrite + Unpin>(&self, a: &mut A) -> Result<(), Error>

Writes a value to a writer.

impl Ipv4Prefix

pub fn version(&self) -> u8

Returns the value of the version field of the header.

pub fn session(&self) -> u16

Returns the value of the session field of the header.

Note that this field is used for other purposes in some PDU types.

pub fn size() -> u32

Returns the PDU size.

The size is returned as a u32 since that type is used in the header.

pub async fn read<Sock: AsyncRead + Unpin>(
    sock: &mut Sock
) -> Result<Self, Error>

Reads a value from a reader.

If a value with a different PDU type is received, returns an error.

pub async fn try_read<Sock: AsyncRead + Unpin>(
    sock: &mut Sock
) -> Result<Result<Self, Header>, Error>

Tries to read a value from a reader.

If a different PDU type is received, returns the header as the error case of the ok case.

pub async fn read_payload<Sock: AsyncRead + Unpin>(
    header: Header,
    sock: &mut Sock
) -> Result<Self, Error>

Reads only the payload part of a value from a reader.

Assuming that the header was already read and is passed via header, the function reads the rest of the PUD from the reader and returns the complete value.

Trait Implementations

impl AsMut<[u8]> for Ipv4Prefix

fn as_mut(&mut self) -> &mut [u8]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8]> for Ipv4Prefix

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Default for Ipv4Prefix

fn default() -> Ipv4Prefix

Returns the “default value” for a type.