Struct capsules_extra::net::ipv6::IPPayload

pub struct IPPayload<'a> {
    pub header: TransportHeader,
    pub payload: &'a mut [u8],
}

The IPPayload struct contains a TransportHeader and a mutable buffer (the payload).

Fields

header: TransportHeader

payload: &'a mut [u8]

Implementations

impl<'a> IPPayload<'a>

pub fn new(header: TransportHeader, payload: &'a mut [u8]) -> IPPayload<'a>

This function constructs a new IPPayload struct

Arguments

header - A TransportHeader for the IPPayload payload - A reference to a mutable buffer for the raw payload

pub fn set_payload( &mut self, transport_header: TransportHeader, payload: &SubSliceMut<'static, u8>, ) -> (u8, u16)

This function sets the payload for the IPPayload, and sets both the TransportHeader and copies the provided payload buffer.

Arguments

transport_header - The new TransportHeader header for the payload payload - The payload to be copied into the IPPayload

Return Value

(u8, u16) - Returns a tuple of the ip6_nh type of the transport_header and the total length of the IPPayload (when serialized)

pub fn encode(&self, buf: &mut [u8], offset: usize) -> SResult<usize>

This function encodes the IPPayload as a byte array

Arguments

buf - SubSliceMut to write the serialized IPPayload to offset - Current offset into the buffer

Return Value

SResult<usize> - The final offset into the buffer buf is returned wrapped in an SResult