Struct Message

pub struct Message {
    pub op: OpCode,
    pub xid: u32,
    pub secs: u16,
    pub bdcast_flag: bool,
    pub ciaddr: Ipv4Addr,
    pub yiaddr: Ipv4Addr,
    pub siaddr: Ipv4Addr,
    pub giaddr: Ipv4Addr,
    pub chaddr: Mac,
    pub sname: String,
    pub file: String,
    pub options: Vec<DhcpOption>,
}

A DHCP protocol message as defined in RFC 2131.

All fields in Message follow the naming conventions outlined in the RFC. Note that Message does not expose htype, hlen, or hops fields, as these fields are effectively constants.

Fields

op: OpCode

xid: u32

secs: u16

bdcast_flag: bool

ciaddr: Ipv4Addr

ciaddr should be stored in Big-Endian order, e.g [192, 168, 1, 1].

yiaddr: Ipv4Addr

yiaddr should be stored in Big-Endian order, e.g [192, 168, 1, 1].

siaddr: Ipv4Addr

siaddr should be stored in Big-Endian order, e.g [192, 168, 1, 1].

giaddr: Ipv4Addr

giaddr should be stored in Big-Endian order, e.g [192, 168, 1, 1].

chaddr: Mac

chaddr should be stored in Big-Endian order, e.g [0xAA, 0xBB, 0xCC, 0xDD, 0xEE, 0xFF].

sname: String

sname should not exceed 64 characters.

file: String

file should not exceed 128 characters.

options: Vec<DhcpOption>

Implementations

impl Message

pub fn from_buffer(buf: &[u8]) -> Result<Self, ProtocolError>

Instantiates a new Message from a byte buffer conforming to the DHCP protocol as defined RFC 2131. Returns None if the buffer is malformed. Any malformed configuration options will be skipped over, leaving only well formed DhcpOptions in the final Message.

pub fn serialize(self) -> Vec<u8>

Consumes the calling Message to serialize it into a buffer of bytes.

pub fn get_dhcp_type(&self) -> Result<MessageType, ProtocolError>

Returns the value’s DHCP MessageType or appropriate MessageTypeError in case of failure.

Trait Implementations

impl Debug for Message

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

Formats the value using the given formatter.

impl From<&Message> for ClientIdentifier

fn from(msg: &Message) -> ClientIdentifier

Returns the opaque client identifier associated with the argument message.

Typically, a message will contain a DhcpOption::ClientIdentifier which stores the associated opaque client identifier. In the absence of this option, an identifier will be constructed from the chaddr field of the message.

impl PartialEq for Message

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