Struct MbufQueue 

pub struct MbufQueue { /* private fields */ }

Tail-queue of mbufs. Mirrors the C struct mhdr head and the STAILQ_* macros that operated on it.

The container is a VecDeque; insertion at either end is O(1).

Examples

use dynomite::io::mbuf::{MbufPool, MbufQueue};
let pool = MbufPool::default();
let mut q = MbufQueue::new();
q.push_back(pool.get());
q.push_back(pool.get());
assert_eq!(q.len(), 2);
let _ = q.pop_front();
assert_eq!(q.len(), 1);

Implementations

impl MbufQueue

pub fn new() -> Self

Create an empty queue.

pub fn len(&self) -> usize

Number of buffers currently chained.

pub fn is_empty(&self) -> bool

True when the queue holds no buffers.

pub fn push_back(&mut self, mbuf: Mbuf)

Append mbuf at the tail. Mirrors mbuf_insert.

pub fn push_front(&mut self, mbuf: Mbuf)

Insert mbuf at the head. Mirrors mbuf_insert_head.

pub fn pop_front(&mut self) -> Option<Mbuf>

Remove and return the head buffer. Mirrors mbuf_remove applied to the head; the C API allowed removing from any position, but every reference call site removed the head.

pub fn pop_back(&mut self) -> Option<Mbuf>

Remove and return the tail buffer.

pub fn back_mut(&mut self) -> Option<&mut Mbuf>

Borrow the tail buffer mutably without removing it. Used by the mbuf_split consumers that want to operate on the latest chunk.

pub fn front_mut(&mut self) -> Option<&mut Mbuf>

Borrow the head buffer mutably without removing it.

pub fn iter(&self) -> Iter<'_, Mbuf>

Iterate the queued buffers in head-to-tail order.

impl MbufQueue

pub fn total_len(&self) -> usize

Total readable bytes across the chain.

pub fn recycle(&mut self, pool: &MbufPool)

Drain the queue into the pool, recycling every chunk.

Examples

use dynomite::io::mbuf::{MbufPool, MbufQueue};
let pool = MbufPool::default();
let mut q = MbufQueue::new();
q.push_back(pool.get());
q.push_back(pool.get());
q.recycle(&pool);
assert!(q.is_empty());

Trait Implementations

impl Debug for MbufQueue

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

Formats the value using the given formatter.

impl Default for MbufQueue

fn default() -> MbufQueue

Returns the “default value” for a type.

impl<'a> IntoIterator for &'a MbufQueue

type Item = &'a Mbuf

The type of the elements being iterated over.

type IntoIter = Iter<'a, Mbuf>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.