Struct DoubleMappedBuffer

pub struct DoubleMappedBuffer<T> { /* private fields */ }

A buffer that is mapped twice, back-to-back in the virtual address space of the process.

This struct is supposed to be used as a base for buffer implementations that want to exploit the consequtive mappings to present available buffer space sequentially, without having to worry about wrapping.

Implementations

impl<T> DoubleMappedBuffer<T>

pub fn new(min_items: usize) -> Result<Self, DoubleMappedBufferError>

Create a buffer that can hold at least min_items items.

The acutal capacity of the buffer will be the smallest multiple of the system page size and the item size that can hold at least min_items items.

pub unsafe fn slice(&self) -> &[T]

Returns the slice corresponding to the first mapping of the buffer.

Safety

Provides raw access to the slice.

pub unsafe fn slice_mut(&self) -> &mut [T]

Returns the mutable slice corresponding to the first mapping of the buffer.

Safety

Provides raw access to the slice.

pub unsafe fn slice_with_offset(&self, offset: usize) -> &[T]

View of the full buffer, shifted by an offset.

Safety

Provides raw access to the slice. The offset has to be <= the capacity of the buffer.

pub unsafe fn slice_with_offset_mut(&self, offset: usize) -> &mut [T]

Mutable view of the full buffer, shifted by an offset.

Safety

Provides raw access to the slice. The offset has to be <= the capacity of the buffer.

pub fn capacity(&self) -> usize

The capacity of the buffer, i.e., how many items it can hold.