Struct PoolRef 

pub struct PoolRef { /* private fields */ }

A reference to a page cache that can be shared across threads via cloning, along with the page size that will be used with it. Provides the API for interacting with the buffer pool in a thread-safe manner.

Implementations

impl PoolRef

pub fn new(page_size: NonZeroU16, capacity: NonZeroUsize) -> Self

Returns a new PoolRef that will buffer up to capacity pages with the given page_size.

pub const fn page_size(&self) -> u64

The page size used by this buffer pool.

pub async fn next_id(&self) -> u64

Returns a unique id for the next blob that will use this buffer pool.

pub const fn offset_to_page(&self, offset: u64) -> (u64, u64)

Convert a logical offset into the number of the page it belongs to and the offset within that page.

pub async fn cache(&self, blob_id: u64, buf: &[u8], offset: u64) -> usize

Cache the provided pages of data in the buffer pool, returning the remaining bytes that didn’t fill a whole page. offset must be page aligned.

Panics

• Panics if offset is not page aligned.
• If the buffer is not the size of a page.

Trait Implementations

impl Clone for PoolRef

fn clone(&self) -> PoolRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.