Skip to main content

MbufPool

Struct MbufPool 

Source
pub struct MbufPool { /* private fields */ }
Expand description

Free-list backed mbuf pool.

The pool keeps a parking-lot mutex around a stash of recyclable chunk allocations. New chunks are taken from the stash if available and freshly allocated otherwise. MbufPool::put returns chunks to the stash up to MBUF_POOL_MAX_FREE; chunks beyond that cap are dropped.

The pool tracks total live and free counts for diagnostics, mirroring the C mbuf_alloc_get_count / mbuf_free_queue_size accessors.

Implementations§

Source§

impl MbufPool

Source

pub fn new(chunk_size: usize, max_free: usize) -> Self

Construct a new pool with chunk_size byte chunks and a free list capped at max_free. Mirrors mbuf_init plus the Rust- only free-list bound.

§Examples
use dynomite::io::mbuf::{MbufPool, MBUF_SIZE, MBUF_POOL_MAX_FREE};
let pool = MbufPool::new(MBUF_SIZE, MBUF_POOL_MAX_FREE);
let buf = pool.get();
assert_eq!(buf.chunk_size(), MBUF_SIZE);
pool.put(buf);
Source

pub fn chunk_size(&self) -> usize

Configured chunk size, in bytes.

Source

pub fn max_free(&self) -> usize

Maximum number of chunks the free list retains.

Source

pub fn get(&self) -> Mbuf

Take a fresh or recycled chunk from the pool. Mirrors mbuf_get.

§Examples
use dynomite::io::mbuf::MbufPool;
let pool = MbufPool::default();
let buf = pool.get();
assert!(buf.is_empty());
Source

pub fn put(&self, mbuf: Mbuf)

Return a chunk to the free list. Resets cursors and flags before storing. Mirrors mbuf_put. Chunks past max_free are dropped.

§Examples
use dynomite::io::mbuf::MbufPool;
let pool = MbufPool::default();
let buf = pool.get();
pool.put(buf);
assert_eq!(pool.free_count(), 1);
Source

pub fn free_count(&self) -> usize

Number of chunks currently sitting in the free list. Mirrors mbuf_free_queue_size.

Source

pub fn total_allocated(&self) -> u64

Lifetime count of fresh allocations performed by the pool. Mirrors mbuf_alloc_get_count. Useful for tests asserting that recycling avoids the allocator path.

Trait Implementations§

Source§

impl Clone for MbufPool

Source§

fn clone(&self) -> MbufPool

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MbufPool

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MbufPool

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,