Struct etherparse::IpAuthenticationHeader

pub struct IpAuthenticationHeader {
    pub next_header: u8,
    pub spi: u32,
    pub sequence_number: u32,
    /* private fields */
}

IP Authentication Header (rfc4302)

Fields

next_header: u8

IP protocol number specifying the next header or transport layer protocol.

See IpNumber or ip_number for a definition of the known values.

spi: u32

Security Parameters Index

sequence_number: u32

This unsigned 32-bit field contains a counter value that increases by one for each packet sent.

Implementations

impl<'a> IpAuthenticationHeader

pub const MAX_ICV_LEN: usize = 1_016usize

pub fn new(
    next_header: u8,
    spi: u32,
    sequence_number: u32,
    raw_icv: &'a [u8]
) -> Result<IpAuthenticationHeader, ValueError>

Create a new authentication header with the given parameters.

Note: The length of the raw_icv slice must be a multiple of 4 and the maximum allowed length is 1016 bytes (IpAuthenticationHeader::MAX_ICV_LEN). If the slice length does not fullfill these requirements the value is not copied and an Err(ValueError::IpAuthenticationHeaderBadIcvLength) is returned. If successfull an Ok(()) is returned.

pub fn from_slice(
    slice: &'a [u8]
) -> Result<(IpAuthenticationHeader, &'a [u8]), ReadError>

Read an authentication header from a slice and return the header & unused parts of the slice.

pub fn read<T: Read + Seek + Sized>(
    reader: &mut T
) -> Result<IpAuthenticationHeader, ReadError>

Read an authentication header from the current reader position.

pub fn raw_icv(&self) -> &[u8]

Returns a slice the raw icv value.

pub fn set_raw_icv(&mut self, raw_icv: &[u8]) -> Result<(), ValueError>

Sets the icv value to the given raw value. The length of the slice must be a multiple of 4 and the maximum allowed length is 1016 bytes (IpAuthenticationHeader::MAX_ICV_LEN). If the slice length does not fullfill these requirements the value is not copied and an Err(ValueError::IpAuthenticationHeaderBadIcvLength) is returned. If successfull an Ok(()) is returned.

pub fn write<T: Write + Sized>(&self, writer: &mut T) -> Result<(), WriteError>

Writes the given authentication header to the current position.

pub fn header_len(&self) -> usize

Length of the header in bytes.

Trait Implementations

impl Clone for IpAuthenticationHeader

fn clone(&self) -> IpAuthenticationHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IpAuthenticationHeader

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

Formats the value using the given formatter.

impl PartialEq<IpAuthenticationHeader> for IpAuthenticationHeader

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