Struct netlink_packet_core::NetlinkMessage

#[non_exhaustive]
pub struct NetlinkMessage<I> {
    pub header: NetlinkHeader,
    pub payload: NetlinkPayload<I>,
}

Represent a netlink message.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

header: NetlinkHeader

Message header (this is common to all the netlink protocols)

payload: NetlinkPayload<I>

Inner message, which depends on the netlink protocol being used.

Implementations

impl<I> NetlinkMessage<I>

pub fn new(header: NetlinkHeader, payload: NetlinkPayload<I>) -> Self

Create a new netlink message from the given header and payload

pub fn into_parts(self) -> (NetlinkHeader, NetlinkPayload<I>)

Consume this message and return its header and payload

impl<I> NetlinkMessage<I>

where I: NetlinkDeserializable, I::Error: Into<DecodeError>,

pub fn deserialize(buffer: &[u8]) -> Result<Self, DecodeError>

Parse the given buffer as a netlink message

impl<I> NetlinkMessage<I>

where I: NetlinkSerializable,

pub fn buffer_len(&self) -> usize

Return the length of this message in bytes

pub fn serialize(&self, buffer: &mut [u8])

Serialize this message and write the serialized data into the given buffer. buffer must big large enough for the whole message to fit, otherwise, this method will panic. To know how big the serialized message is, call buffer_len().

Panic

This method panics if the buffer is not big enough.

pub fn finalize(&mut self)

Ensure the header (NetlinkHeader) is consistent with the payload (NetlinkPayload):

• compute the payload length and set the header’s length field
• check the payload type and set the header’s message type field accordingly

If you are not 100% sure the header is correct, this method should be called before calling [Emitable::emit()](trait.Emitable.html# tymethod.emit), as it could panic if the header is inconsistent with the rest of the message.

Trait Implementations

impl<I: Clone> Clone for NetlinkMessage<I>

fn clone(&self) -> NetlinkMessage<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Debug> Debug for NetlinkMessage<I>

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

Formats the value using the given formatter.

impl<I> Emitable for NetlinkMessage<I>

where I: NetlinkSerializable,

fn buffer_len(&self) -> usize

Return the length of the serialized data.

fn emit(&self, buffer: &mut [u8])

Serialize this types and write the serialized data into the given buffer.

impl<T> From<T> for NetlinkMessage<T>

where T: Into<NetlinkPayload<T>>,

fn from(inner_message: T) -> Self

Converts to this type from the input type.

impl<'buffer, B, I> Parseable<NetlinkBuffer<&'buffer B>> for NetlinkMessage<I>

where B: AsRef<[u8]> + 'buffer, I: NetlinkDeserializable, I::Error: Into<DecodeError>,

type Error = DecodeError

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

Deserialize the current type.

impl<I: PartialEq> PartialEq for NetlinkMessage<I>

fn eq(&self, other: &NetlinkMessage<I>) -> 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<I: Eq> Eq for NetlinkMessage<I>

impl<I> StructuralPartialEq for NetlinkMessage<I>