Struct xsk_rs::umem::frame::Cursor

pub struct Cursor<'a> { /* private fields */ }

Wraps a buffer and a value denoting its current write position and provides a convenient Write implementation.

Practically it allows us to write to a Umem frame and update its descriptor’s length at the same time, avoiding some potentially error prone logic.

Implementations

impl<'a> Cursor<'a>

pub fn pos(&self) -> usize

The cursor’s current write position in the buffer.

pub fn set_pos(&mut self, pos: usize)

Sets the cursor’s write position.

pub fn buf_len(&mut self) -> usize

The length of the underlying buffer.

pub fn zero_out(&mut self)

Fills the buffer with zeroes and sets the cursor’s write position to the start of the buffer.

Trait Implementations

impl<'a> Debug for Cursor<'a>

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

Formats the value using the given formatter.

impl Write for Cursor<'_>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>

Like write, except that it writes from a slice of buffers.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn is_write_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a “by reference” adapter for this instance of Write.