Struct uapi::NlmsgWriter

pub struct NlmsgWriter<'a, H: NlmsgHeader = ()> { /* private fields */ }

👎Deprecated: beta features are subject to change at any time

A writer for netlink messages

See also the crate documentation.

Implementations

impl<'a, H: NlmsgHeader> NlmsgWriter<'a, H>

pub fn new<T: Pod + ?Sized>(buf: &'a mut T, header: H) -> Result<Self>

Creates a new writer that uses the buffer as backing storage

pub fn write<T: ?Sized>(&mut self, data: &T) -> Result<()>

Writes an object to the buffer

This involves three steps:

• The write position is aligned to the next 4 byte boundary
• The object is written
• The write position is advanced by the size of the object

Returns an error if the buffer does not contain enough space.

pub fn nest<H2: NlmsgHeader>( &mut self, header: H2 ) -> Result<NlmsgWriter<'_, H2>>

Nests a new message within the write buffer

Returns an error if there is not enough space to write the header at the next 4 byte boundary.

When the nested writer is dropped, the behavior is as if the nested message had been written to a separate buffer and then written to this writer using Self::write.

pub fn finalize(self) -> Result<&'a mut [u8]>

Sets the length field of the header to the correct value

This function returns an error if [NlmsgHeader::set_len] fails.

Trait Implementations

impl<'a, H: NlmsgHeader> Drop for NlmsgWriter<'a, H>

fn drop(&mut self)

Executes the destructor for this type.