Skip to main content

BufferPool

Struct BufferPool 

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

A worker’s buffer pool: free lists per size class, drawing new buffers from a budget shared by every worker of a server.

The budget comes back: a pool keeps at most a fixed number of bytes in its free lists (a server’s pools keep the budget divided by the workers, a fair share) and frees what is released above that, and a take that finds its own class’s list empty and the budget short frees buffers of other classes first, so a burst of one size class does not hold the budget from the others for good.

Implementations§

Source§

impl BufferPool

Source

pub fn standalone(bytes: u64) -> BufferPool

A pool with its own budget of bytes, for use outside a server. It keeps every buffer released to it, up to the whole budget.

let mut pool = net_io::BufferPool::standalone(64 * 1024);
assert!(pool.take(net_io::SizeClass::LARGE).is_some());
assert!(pool.take(net_io::SizeClass::LARGE).is_none()); // budget spent
Source

pub fn take(&mut self, class: SizeClass) -> Option<Buffer>

A buffer of class, or None when the free list is empty and the budget is spent even after freeing what this pool holds of other classes.

use net_io::{BufferPool, SizeClass};
let mut pool = BufferPool::standalone(64 * 1024);
let large = pool.take(SizeClass::LARGE).unwrap();
pool.put(large); // the budget is spent, the buffer is cached
// A smaller class frees the cached 64 KiB buffer to make room.
assert!(pool.take(SizeClass::MEDIUM).is_some());
assert_eq!(pool.stats().freed, 1);
Source

pub fn put(&mut self, buf: Buffer)

Returns a buffer; its used part is wiped first unless wiping is off.

A buffer from another worker’s pool is accepted (it is just memory). When the free lists already hold what this pool keeps, the buffer is freed and its bytes go back to the shared budget instead.

use net_io::{BufferPool, SizeClass};
let mut pool = BufferPool::standalone(1 << 20);
let b = pool.take(SizeClass::SMALL).unwrap();
pool.put(b);
assert_eq!(pool.stats().free, 1);
Source

pub fn stats(&self) -> PoolStats

Counts of this pool.

Trait Implementations§

Source§

impl Debug for BufferPool

Source§

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

Formats the value using the given formatter. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.