Enum NlPayload

pub enum NlPayload<T, P> {
    Ack(Nlmsgerr<NlmsghdrAck<T>>),
    DumpExtAck(Nlmsgerr<()>),
    Err(Nlmsgerr<NlmsghdrErr<T, P>>),
    Payload(P),
    Empty,
}

An enum representing either the desired payload as requested by the payload type parameter, an ACK received at the end of a message or stream of messages, or an error.

Variants

Ack(Nlmsgerr<NlmsghdrAck<T>>)

Represents an ACK returned by netlink.

DumpExtAck(Nlmsgerr<()>)

Represents an ACK extracted from the DONE packet returned by netlink on a DUMP.

Err(Nlmsgerr<NlmsghdrErr<T, P>>)

Represents an application level error returned by netlink.

Payload(P)

Represents the requested payload.

Empty

Indicates an empty payload.

Implementations

impl NlPayload<u16, Buffer>

pub fn to_typed<T, P>( self, payload_size: usize, ) -> Result<NlPayload<T, P>, RouterError<T, P>>

where T: NlType, P: Size + FromBytesWithInput<Input = usize>,

Convert a typed payload from a payload that can represent all types.

Trait Implementations

impl<T: Clone, P: Clone> Clone for NlPayload<T, P>

fn clone(&self) -> NlPayload<T, P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, P: Debug> Debug for NlPayload<T, P>

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

Formats the value using the given formatter.

impl<T, P> FromBytesWithInput for NlPayload<T, P>

where P: Size + FromBytesWithInput<Input = usize>, T: NlType,

type Input = (usize, T, NlmF)

The type of the additional input.

fn from_bytes_with_input( buffer: &mut Cursor<impl AsRef<[u8]>>, (input_size, input_type, flags): (usize, T, NlmF), ) -> Result<Self, DeError>

Takes a byte buffer and an additional input and returns the deserialized data structure.

fn strip(buffer: &mut Cursor<impl AsRef<[u8]>>) -> Result<(), DeError>

Strip padding from a netlink message.

impl<T: PartialEq, P: PartialEq> PartialEq for NlPayload<T, P>

fn eq(&self, other: &NlPayload<T, P>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Size, P: Size> Size for NlPayload<T, P>

fn unpadded_size(&self) -> usize

Size of the unpadded data structure. This will usually only be unaligned for variable length types like strings or byte buffers.

fn padded_size(&self) -> usize

Get the size of the payload and align it to the required netlink byte alignment.

impl<T: ToBytes, P: ToBytes> ToBytes for NlPayload<T, P>

fn to_bytes(&self, buffer: &mut Cursor<Vec<u8>>) -> Result<(), SerError>

Takes a byte buffer and serializes the data structure into it.

fn pad(&self, buffer: &mut Cursor<Vec<u8>>) -> Result<(), SerError>

Pad a netlink message to the appropriate alignment.

impl<T: Eq, P: Eq> Eq for NlPayload<T, P>

impl<T, P> StructuralPartialEq for NlPayload<T, P>