Struct dhcproto::v6::Message

pub struct Message { /* private fields */ }

See RFC 8415 for updated DHCPv6 info DHCP for Ipv6

All DHCP messages sent between clients and servers share an identical fixed-format header and a variable-format area for options.

All values in the message header and in options are in network byte order.

Options are stored serially in the “options” field, with no padding between the options. Options are byte-aligned but are not aligned in any other way (such as on 2-byte or 4-byte boundaries).

The following diagram illustrates the format of DHCP messages sent between clients and servers:

      0                   1                   2                   3
      0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     |    msg-type   |               transaction-id                  |
     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     |                                                               |
     .                            options                            .
     .                 (variable number and length)                  .
     |                                                               |
     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

     msg-type             Identifies the DHCP message type; the
                          available message types are listed in
                          Section 7.3.  A 1-octet field.

     transaction-id       The transaction ID for this message exchange.
                          A 3-octet field.

     options              Options carried in this message; options are
                          described in Section 21.  A variable-length
                          field (4 octets less than the size of the
                          message).

Implementations

impl Message

pub fn new(msg_type: MessageType) -> Self

returns a new Message with a random xid and empty opt section

pub fn new_with_id(msg_type: MessageType, xid: [u8; 3]) -> Self

returns a new Message with a given xid and message type and empty opt section

pub fn msg_type(&self) -> MessageType

Get the message’s message type.

pub fn set_msg_type(&mut self, msg_type: MessageType) -> &mut Self

Set message type

pub fn xid(&self) -> [u8; 3]

Get the message’s transaction id.

pub fn xid_num(&self) -> u32

Get the msgs transaction id as a number

pub fn set_xid(&mut self, xid: [u8; 3]) -> &mut Self

Set transaction id

pub fn set_xid_num(&mut self, xid: u32) -> &mut Self

Set transaction id from u32, will only use last 3 bytes

pub fn opts(&self) -> &DhcpOptions

Get a reference to the message’s options.

pub fn set_opts(&mut self, opts: DhcpOptions) -> &mut Self

Set DHCP opts

pub fn opts_mut(&mut self) -> &mut DhcpOptions

Get a mutable reference to the message’s options.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Decodable for Message

fn decode(decoder: &mut Decoder<'_>) -> DecodeResult<Self>

Read the type from the stream

fn from_bytes(bytes: &[u8]) -> DecodeResult<Self>

Returns the object in binary form

impl Default for Message

fn default() -> Self

Returns the “default value” for a type.

impl Display for Message

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

Formats the value using the given formatter.

impl Encodable for Message

fn encode(&self, e: &mut Encoder<'_>) -> EncodeResult<()>

encode type to buffer in Encoder

fn to_vec(&self) -> EncodeResult<Vec<u8>>

encode this type into its binary form in a new Vec

impl PartialEq for Message

fn eq(&self, other: &Message) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Message

impl StructuralEq for Message

impl StructuralPartialEq for Message