Struct netlink_packet_route::NetlinkBuffer

pub struct NetlinkBuffer<T> {
    pub buffer: T,
}

A raw Netlink buffer that provides getters and setter for the various header fields, and to retrieve the payloads.

Example: reading a packet

use netlink_packet_core::{NetlinkBuffer, NLM_F_MATCH, NLM_F_REQUEST, NLM_F_ROOT};

const RTM_GETLINK: u16 = 18;

fn main() {
    // Artificially create an array of bytes that represents a netlink packet.
    // Normally, we would read it from a socket.
    let buffer = vec![
        0x28, 0x00, 0x00, 0x00, // length = 40
        0x12, 0x00, // message type = 18 (RTM_GETLINK)
        0x01, 0x03, // flags = Request + Specify Tree Root + Return All Matching
        0x34, 0x0e, 0xf9, 0x5a, // sequence number = 1526271540
        0x00, 0x00, 0x00, 0x00, // port id = 0
        // payload
        0x11, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x08, 0x00, 0x1d, 0x00, 0x01, 0x00, 0x00, 0x00];

    // Wrap the storage into a NetlinkBuffer
    let packet = NetlinkBuffer::new_checked(&buffer[..]).unwrap();

    // Check that the different accessor return the expected values
    assert_eq!(packet.length(), 40);
    assert_eq!(packet.message_type(), RTM_GETLINK);
    assert_eq!(packet.sequence_number(), 1526271540);
    assert_eq!(packet.port_number(), 0);
    assert_eq!(packet.payload_length(), 24);
    assert_eq!(packet.payload(), &buffer[16..]);
    assert_eq!(
        Into::<u16>::into(packet.flags()),
        NLM_F_ROOT | NLM_F_REQUEST | NLM_F_MATCH
    );
}

Example: writing a packet

use netlink_packet_core::{NetlinkBuffer, NLM_F_MATCH, NLM_F_REQUEST, NLM_F_ROOT};

const RTM_GETLINK: u16 = 18;

fn main() {
    // The packet we want to write.
    let expected_buffer = vec![
        0x28, 0x00, 0x00, 0x00, // length = 40
        0x12, 0x00, // message type = 18 (RTM_GETLINK)
        0x01, 0x03, // flags = Request + Specify Tree Root + Return All Matching
        0x34, 0x0e, 0xf9, 0x5a, // sequence number = 1526271540
        0x00, 0x00, 0x00, 0x00, // port id = 0
        // payload
        0x11, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x08, 0x00, 0x1d, 0x00, 0x01, 0x00, 0x00, 0x00];

    // Create a storage that is big enough for our packet
    let mut buf = vec![0; 40];
    // the extra scope is to restrict the scope of the borrow
    {
        // Create a NetlinkBuffer.
        let mut packet = NetlinkBuffer::new(&mut buf);
        // Set the various fields
        packet.set_length(40);
        packet.set_message_type(RTM_GETLINK);
        packet.set_sequence_number(1526271540);
        packet.set_port_number(0);
        packet.set_flags(From::from(NLM_F_ROOT | NLM_F_REQUEST | NLM_F_MATCH));
        // we kind of cheat here to keep the example short
        packet.payload_mut().copy_from_slice(&expected_buffer[16..]);
    }
    // Check that the storage contains the expected values
    assert_eq!(&buf[..], &expected_buffer[..]);
}

Note that in this second example we don't call new_checked() because the length field is initialized to 0, so new_checked() would return an error.

Fields

buffer: T

Implementations

impl<T> NetlinkBuffer<T> where
    T: AsRef<[u8]> + AsMut<[u8]>, 

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

Set the packet header length field

Panic

This panic is the underlying storage is too small (see new_checked())

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

Set the packet header message_type field

Panic

This panic is the underlying storage is too small (see new_checked())

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

Set the packet header flags field

Panic

This panic is the underlying storage is too small (see new_checked())

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

Set the packet header sequence_number field

Panic

This panic is the underlying storage is too small (see new_checked())

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

Set the packet header port_number field

Panic

This panic is the underlying storage is too small (see new_checked())

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

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

Return a pointer to the packet payload.

Panic

This panic is the underlying storage is too small or if the length field in the header is set to a value that exceeds the storage length (see new_checked())

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

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

Return a mutable pointer to the payload.

Panic

This panic is the underlying storage is too small or if the length field in the header is set to a value that exceeds the storage length (see new_checked())

impl<T> NetlinkBuffer<T> where
    T: AsRef<[u8]>, 

pub fn new(buffer: T) -> NetlinkBuffer<T>

Create a new NetlinkBuffer that uses the given buffer as storage. Note that when calling this method no check is performed, so trying to access fields may panic. If you're not sure the given buffer contains a valid netlink packet, use new_checked() instead.

pub fn new_checked(buffer: T) -> Result<NetlinkBuffer<T>, DecodeError>

Check the length of the given buffer and make sure it's big enough so that trying to access packet fields won't panic. If the buffer is big enough, create a new NewlinkBuffer that uses this buffer as storage.

Example

With a buffer that does not even contain a full header:

use netlink_packet_core::NetlinkBuffer;
static BYTES: [u8; 4] = [0x28, 0x00, 0x00, 0x00];
assert!(NetlinkBuffer::new_checked(&BYTES[..]).is_err());

Here is a slightly more tricky error, where technically, the buffer is big enough to contains a valid packet. Here, accessing the packet header fields would not panic but accessing the payload would, so new_checked also checks the length field in the packet header:

use netlink_packet_core::NetlinkBuffer;
// The buffer is 24 bytes long. It contains a valid header but a truncated payload
static BYTES: [u8; 24] = [
    // The length field says the buffer is 40 bytes long
    0x28, 0x00, 0x00, 0x00,
    0x12, 0x00, // message type
    0x01, 0x03, // flags
    0x34, 0x0e, 0xf9, 0x5a, // sequence number
    0x00, 0x00, 0x00, 0x00, // port id
    // payload
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00];
assert!(NetlinkBuffer::new_checked(&BYTES[..]).is_err());

pub fn payload_length(&self) -> usize

Return the payload length.

Panic

This panic is the underlying storage is too small or if the length field in the header is set to a value that exceeds the storage length (see new_checked())

pub fn into_inner(self) -> T

Consume the packet, returning the underlying buffer.

pub fn length(&self) -> u32

Return the length field

Panic

This panic is the underlying storage is too small (see new_checked())

pub fn message_type(&self) -> u16

Return the type field

Panic

This panic is the underlying storage is too small (see new_checked())

pub fn flags(&self) -> u16

Return the flags field

Panic

This panic is the underlying storage is too small (see new_checked())

pub fn sequence_number(&self) -> u32

Return the sequence_number field

Panic

This panic is the underlying storage is too small (see new_checked())

pub fn port_number(&self) -> u32

Return the port_number field

Panic

This panic is the underlying storage is too small (see new_checked())

Trait Implementations

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

pub fn clone(&self) -> NetlinkBuffer<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for NetlinkBuffer<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T> Eq for NetlinkBuffer<T> where
    T: Eq, 

impl<'a, T> Parseable<NetlinkBuffer<&'a T>> for NetlinkHeader where
    T: AsRef<[u8]> + ?Sized, 

pub fn parse(buf: &NetlinkBuffer<&'a T>) -> Result<NetlinkHeader, DecodeError>

Deserialize the current type.

impl<'buffer, B, I> Parseable<NetlinkBuffer<&'buffer B>> for NetlinkMessage<I> where
    I: Debug + PartialEq<I> + Eq + Clone + NetlinkDeserializable<I>,
    B: AsRef<[u8]> + 'buffer, 

pub fn parse(
    buf: &NetlinkBuffer<&'buffer B>
) -> Result<NetlinkMessage<I>, DecodeError>

Deserialize the current type.

impl<T> PartialEq<NetlinkBuffer<T>> for NetlinkBuffer<T> where
    T: PartialEq<T>, 

pub fn eq(&self, other: &NetlinkBuffer<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &NetlinkBuffer<T>) -> bool

This method tests for !=.

impl<T> StructuralEq for NetlinkBuffer<T>

impl<T> StructuralPartialEq for NetlinkBuffer<T>