Struct smoltcp::wire::DhcpPacket

pub struct DhcpPacket<T: AsRef<[u8]>> { /* private fields */ }

A read/write wrapper around a Dynamic Host Configuration Protocol packet buffer.

Implementations

impl<T: AsRef<[u8]>> Packet<T>

pub const fn new_unchecked(buffer: T) -> Packet<T>

Imbue a raw octet buffer with DHCP packet structure.

pub fn new_checked(buffer: T) -> Result<Packet<T>>

Shorthand for a combination of new_unchecked and check_len.

pub fn check_len(&self) -> Result<()>

Ensure that no accessor method will panic if called. Returns Err(Error) if the buffer is too short.

pub fn into_inner(self) -> T

Consume the packet, returning the underlying buffer.

pub fn opcode(&self) -> OpCode

Returns the operation code of this packet.

pub fn hardware_type(&self) -> Hardware

Returns the hardware protocol type (e.g. ethernet).

pub fn hardware_len(&self) -> u8

Returns the length of a hardware address in bytes (e.g. 6 for ethernet).

pub fn transaction_id(&self) -> u32

Returns the transaction ID.

The transaction ID (called xid in the specification) is a random number used to associate messages and responses between client and server. The number is chosen by the client.

pub fn client_hardware_address(&self) -> EthernetAddress

Returns the hardware address of the client (called chaddr in the specification).

Only ethernet is supported by smoltcp, so this functions returns an EthernetAddress.

pub fn hops(&self) -> u8

Returns the value of the hops field.

The hops field is set to zero by clients and optionally used by relay agents.

pub fn secs(&self) -> u16

Returns the value of the secs field.

The secs field is filled by clients and describes the number of seconds elapsed since client began process.

pub fn magic_number(&self) -> u32

Returns the value of the magic cookie field in the DHCP options.

This field should be always be 0x63825363.

pub fn client_ip(&self) -> Ipv4Address

Returns the Ipv4 address of the client, zero if not set.

This corresponds to the ciaddr field in the DHCP specification. According to it, this field is “only filled in if client is in BOUND, RENEW or REBINDING state and can respond to ARP requests”.

pub fn your_ip(&self) -> Ipv4Address

Returns the value of the yiaddr field, zero if not set.

pub fn server_ip(&self) -> Ipv4Address

Returns the value of the siaddr field, zero if not set.

pub fn relay_agent_ip(&self) -> Ipv4Address

Returns the value of the giaddr field, zero if not set.

pub fn flags(&self) -> Flags

pub fn options(&self) -> impl Iterator<Item = DhcpOption<'_>> + '_

Return an iterator over the options.

pub fn get_sname(&self) -> Result<&str>

pub fn get_boot_file(&self) -> Result<&str>

impl<T: AsRef<[u8]> + AsMut<[u8]>> Packet<T>

pub fn set_sname_and_boot_file_to_zero(&mut self)

Sets the optional sname (“server name”) and file (“boot file name”) fields to zero.

The fields are not commonly used, so we set their value always to zero. This method must be called when creating a packet, otherwise the emitted values for these fields are undefined!

pub fn set_opcode(&mut self, value: OpCode)

Sets the OpCode for the packet.

pub fn set_hardware_type(&mut self, value: Hardware)

Sets the hardware address type (only ethernet is supported).

pub fn set_hardware_len(&mut self, value: u8)

Sets the hardware address length.

Only ethernet is supported, so this field should be set to the value 6.

pub fn set_transaction_id(&mut self, value: u32)

Sets the transaction ID.

The transaction ID (called xid in the specification) is a random number used to associate messages and responses between client and server. The number is chosen by the client.

pub fn set_client_hardware_address(&mut self, value: EthernetAddress)

Sets the ethernet address of the client.

Sets the chaddr field.

pub fn set_hops(&mut self, value: u8)

Sets the hops field.

The hops field is set to zero by clients and optionally used by relay agents.

pub fn set_secs(&mut self, value: u16)

Sets the secs field.

The secs field is filled by clients and describes the number of seconds elapsed since client began process.

pub fn set_magic_number(&mut self, value: u32)

Sets the value of the magic cookie field in the DHCP options.

This field should be always be 0x63825363.

pub fn set_client_ip(&mut self, value: Ipv4Address)

Sets the Ipv4 address of the client.

This corresponds to the ciaddr field in the DHCP specification. According to it, this field is “only filled in if client is in BOUND, RENEW or REBINDING state and can respond to ARP requests”.

pub fn set_your_ip(&mut self, value: Ipv4Address)

Sets the value of the yiaddr field.

pub fn set_server_ip(&mut self, value: Ipv4Address)

Sets the value of the siaddr field.

pub fn set_relay_agent_ip(&mut self, value: Ipv4Address)

Sets the value of the giaddr field.

pub fn set_flags(&mut self, val: Flags)

Sets the flags to the specified value.

impl<'a, T: AsRef<[u8]> + AsMut<[u8]> + ?Sized> Packet<&'a mut T>

pub fn options_mut(&mut self) -> DhcpOptionWriter<'_>

Return a pointer to the options.

Trait Implementations

impl<T: Clone + AsRef<[u8]>> Clone for Packet<T>

fn clone(&self) -> Packet<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + AsRef<[u8]>> Debug for Packet<T>

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

Formats the value using the given formatter.

impl<T: PartialEq + AsRef<[u8]>> PartialEq<Packet<T>> for Packet<T>

fn eq(&self, other: &Packet<T>) -> 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<T: Copy + AsRef<[u8]>> Copy for Packet<T>

impl<T: Eq + AsRef<[u8]>> Eq for Packet<T>

impl<T: AsRef<[u8]>> StructuralEq for Packet<T>

impl<T: AsRef<[u8]>> StructuralPartialEq for Packet<T>