Struct EthernetFrame

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

A read/write wrapper around an Ethernet II frame buffer.

Implementations

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

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

Imbue a raw octet buffer with Ethernet frame structure.

pub fn new_checked(buffer: T) -> Result<Frame<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

Consumes the frame, returning the underlying buffer.

pub const fn header_len() -> usize

Return the length of a frame header.

pub const fn buffer_len(payload_len: usize) -> usize

Return the length of a buffer required to hold a packet with the payload of a given length.

pub fn dst_addr(&self) -> Address

Return the destination address field.

pub fn src_addr(&self) -> Address

Return the source address field.

pub fn ethertype(&self) -> EtherType

Return the EtherType field, without checking for 802.1Q.

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

pub fn payload(&self) -> &'a [u8]

Return a pointer to the payload, without checking for 802.1Q.

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

pub fn set_dst_addr(&mut self, value: Address)

Set the destination address field.

pub fn set_src_addr(&mut self, value: Address)

Set the source address field.

pub fn set_ethertype(&mut self, value: EtherType)

Set the EtherType field.

pub fn payload_mut(&mut self) -> &mut [u8]

Return a mutable pointer to the payload.

Trait Implementations

impl<T: AsRef<[u8]>> AsRef<[u8]> for Frame<T>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

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

fn clone(&self) -> Frame<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 Frame<T>

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

Formats the value using the given formatter.

impl<T: AsRef<[u8]>> Display for Frame<T>

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

Formats the value using the given formatter.

impl<T: AsRef<[u8]>> PrettyPrint for Frame<T>

fn pretty_print( buffer: &dyn AsRef<[u8]>, f: &mut Formatter<'_>, indent: &mut PrettyIndent, ) -> Result

Write a concise, formatted representation of a packet contained in the provided buffer, and any nested packets it may contain.