Struct DhcpFixedPayload 

pub struct DhcpFixedPayload { /* private fields */ }

The fixed-length part of the DHCP payload. The options section can vary in length, and is handled separately. For “Inform” message kind, this is the entire message.

Implementations

impl DhcpFixedPayload

pub fn new( end_of_message: bool, op: DhcpOperation, kind: DhcpMessageKind, transaction_id: u32, broadcast: bool, ciaddr: IpV4Addr, yiaddr: IpV4Addr, siaddr: IpV4Addr, chaddr: MacAddr, ) -> Self

Convenience function to remove boilerplate for predetermined fields.

pub fn new_inform( ipaddr: IpV4Addr, macaddr: MacAddr, transaction_id: u32, ) -> Self

Build a DHCP INFORM message to broadcast to the network indicating that we are taking a pre-assigned IP address which may have already be assigned statically in the configuration of the router. This message should also be accompanied by an ARP “announce” message to broadcast the presence of the machine to others on the network that may or may not receive a forwarded copy of the DHCP INFORM.

Examples found in repository

examples/dhcp.rs (lines 5-9)

fn main() -> () {
    use catnip::*;

    let dhcp_inform = DhcpFixedPayload::new_inform(
        IpV4Addr::new([1, 2, 3, 4]),
        MacAddr::new([5, 6, 7, 8, 9, 10]),
        12345
    );

    // Serialize
    let bytes = dhcp_inform.to_be_bytes();
    // Deserialize
    let msg_parsed = DhcpFixedPayload::read_bytes(&bytes);

    assert_eq!(msg_parsed, dhcp_inform);
}

pub fn to_be_bytes(&self) -> [u8; 244]

Pack into big-endian (network) byte array

Examples found in repository

examples/dhcp.rs (line 12)

fn main() -> () {
    use catnip::*;

    let dhcp_inform = DhcpFixedPayload::new_inform(
        IpV4Addr::new([1, 2, 3, 4]),
        MacAddr::new([5, 6, 7, 8, 9, 10]),
        12345
    );

    // Serialize
    let bytes = dhcp_inform.to_be_bytes();
    // Deserialize
    let msg_parsed = DhcpFixedPayload::read_bytes(&bytes);

    assert_eq!(msg_parsed, dhcp_inform);
}

Trait Implementations

impl ByteStruct for DhcpFixedPayload

fn write_bytes(&self, bytes: &mut [u8])

Packs the struct into raw bytes and write to a slice

fn read_bytes(bytes: &[u8]) -> Self

Unpacks raw bytes from a slice into a new struct

impl ByteStructLen for DhcpFixedPayload

const BYTE_LEN: usize = 244usize

The length of the packed bytes of this type

impl Clone for DhcpFixedPayload

fn clone(&self) -> DhcpFixedPayload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DhcpFixedPayload

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

Formats the value using the given formatter.

impl PartialEq for DhcpFixedPayload

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

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

where W: uWrite + ?Sized,

Formats the value using the given formatter

impl Copy for DhcpFixedPayload

impl Eq for DhcpFixedPayload

impl StructuralPartialEq for DhcpFixedPayload