Skip to main content

DhcpLayer

Struct DhcpLayer 

Source
pub struct DhcpLayer {
    pub index: LayerIndex,
}
Expand description

DHCP layer — a zero-copy view into a parsed DHCP packet.

Fields§

§index: LayerIndex

Implementations§

Source§

impl DhcpLayer

Source

pub fn new(index: LayerIndex) -> Self

Source

pub fn op(&self, buf: &[u8]) -> Result<u8, FieldError>

BOOTP op code: 1 = request, 2 = reply.

Source

pub fn htype(&self, buf: &[u8]) -> Result<u8, FieldError>

Hardware type (1 = Ethernet).

Source

pub fn hlen(&self, buf: &[u8]) -> Result<u8, FieldError>

Hardware address length.

Source

pub fn hops(&self, buf: &[u8]) -> Result<u8, FieldError>

Hops.

Source

pub fn xid(&self, buf: &[u8]) -> Result<u32, FieldError>

Transaction ID.

Source

pub fn secs(&self, buf: &[u8]) -> Result<u16, FieldError>

Seconds elapsed.

Source

pub fn flags(&self, buf: &[u8]) -> Result<u16, FieldError>

Flags.

Source

pub fn ciaddr(&self, buf: &[u8]) -> Result<Ipv4Addr, FieldError>

Client IP address.

Source

pub fn yiaddr(&self, buf: &[u8]) -> Result<Ipv4Addr, FieldError>

Your (client) IP address.

Source

pub fn siaddr(&self, buf: &[u8]) -> Result<Ipv4Addr, FieldError>

Server IP address.

Source

pub fn giaddr(&self, buf: &[u8]) -> Result<Ipv4Addr, FieldError>

Gateway IP address.

Source

pub fn chaddr(&self, buf: &[u8]) -> Result<[u8; 6], FieldError>

Client hardware address (first 6 bytes for Ethernet).

Source

pub fn options(&self, buf: &[u8]) -> Vec<DhcpOption>

Parse all DHCP options.

Source

pub fn get_option(&self, buf: &[u8], opt_code: u8) -> Option<DhcpOption>

Get a specific option by code.

Source

pub fn msg_type(&self, buf: &[u8]) -> Option<u8>

Get the DHCP message type.

Source

pub fn server_id(&self, buf: &[u8]) -> Option<Ipv4Addr>

Get the server identifier.

Source

pub fn requested_ip(&self, buf: &[u8]) -> Option<Ipv4Addr>

Get the requested IP address.

Source

pub fn lease_time(&self, buf: &[u8]) -> Option<u32>

Get the lease time option value.

Source

pub fn subnet_mask(&self, buf: &[u8]) -> Option<Ipv4Addr>

Get the subnet mask option.

Source

pub fn router(&self, buf: &[u8]) -> Option<Ipv4Addr>

Get the router option.

Source

pub fn dns(&self, buf: &[u8]) -> Vec<Ipv4Addr>

Get the DNS servers option.

Source

pub fn is_request(&self, buf: &[u8]) -> bool

Check if this is a DHCP request (BOOTP op=1).

Source

pub fn is_reply(&self, buf: &[u8]) -> bool

Check if this is a DHCP reply (BOOTP op=2).

Source

pub fn set_op(&self, buf: &mut [u8], val: u8) -> Result<(), FieldError>

Set the op field.

Source

pub fn set_xid(&self, buf: &mut [u8], val: u32) -> Result<(), FieldError>

Set the xid field.

Source

pub fn set_flags(&self, buf: &mut [u8], val: u16) -> Result<(), FieldError>

Set the flags field.

Source

pub fn get_field( &self, buf: &[u8], name: &str, ) -> Option<Result<FieldValue, FieldError>>

Get field value by name.

Source

pub fn set_field( &self, buf: &mut [u8], name: &str, value: FieldValue, ) -> Option<Result<(), FieldError>>

Set field value by name.

Source

pub fn field_names(&self) -> &'static [&'static str]

Field names for this layer.

Trait Implementations§

Source§

impl Clone for DhcpLayer

Source§

fn clone(&self) -> DhcpLayer

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DhcpLayer

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<DhcpLayer> for LayerEnum

Source§

fn from(v: DhcpLayer) -> LayerEnum

Converts to this type from the input type.
Source§

impl Layer for DhcpLayer

Source§

fn kind(&self) -> LayerKind

Get the kind of this layer
Source§

fn summary(&self, buf: &[u8]) -> String

Get a human-readable summary of this layer
Source§

fn header_len(&self, buf: &[u8]) -> usize

Get the header length for this layer
Source§

fn field_names(&self) -> &'static [&'static str]

Get the list of field names for this layer
Source§

fn hashret(&self, _data: &[u8]) -> Vec<u8>

Compute a hash for packet matching.
Source§

fn answers(&self, _data: &[u8], _other: &Self, _other_data: &[u8]) -> bool

Check if this packet answers another packet.
Source§

fn extract_padding<'a>(&self, data: &'a [u8]) -> (&'a [u8], &'a [u8])

Extract padding from the packet.
Source§

impl LayerDispatch for DhcpLayer

Source§

fn dispatch_kind(&self) -> LayerKind

Get the kind of this layer.
Source§

fn dispatch_index(&self) -> &LayerIndex

Get the layer index (start/end offsets).
Source§

fn dispatch_summary(&self, buf: &[u8]) -> String

Get a human-readable summary.
Source§

fn dispatch_header_len(&self, buf: &[u8]) -> usize

Get the header length in bytes.
Source§

fn dispatch_hashret(&self, buf: &[u8]) -> Vec<u8>

Compute a hash for packet matching.
Source§

fn dispatch_field_names(&self) -> &'static [&'static str]

Get field names for this layer type.
Source§

fn dispatch_get_field( &self, buf: &[u8], name: &str, ) -> Option<Result<FieldValue, FieldError>>

Get a field value by name.
Source§

fn dispatch_set_field( &self, buf: &mut [u8], name: &str, value: FieldValue, ) -> Option<Result<(), FieldError>>

Set a field value by name.
Source§

fn dispatch_show_fields(&self, buf: &[u8]) -> Vec<(&'static str, String)>

Get show-fields output.
Source§

impl TryInto<DhcpLayer> for LayerEnum

Source§

type Error = &'static str

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<DhcpLayer, <Self as TryInto<DhcpLayer>>::Error>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V