Skip to main content

Buffer

Struct Buffer 

Source
pub struct Buffer<T> { /* private fields */ }
Expand description

A buffer of copy values with a max size of u32::MAX. Make sure to interreact with the buffer through a session when writing and reading from the buffer:

let mut buffer = Buffer::empty();
let mut session = buffer.new_session();
let key = session.next_slice();

session.extend([1, 2, 3]);

assert_eq!(buffer.get(key), &[1, 2, 3]);

and use the SliceIndex to access the buffer.

Implementations§

Source§

impl<T: Copy> Buffer<T>

Source

pub fn empty() -> Self

Create an empty buffer.

Source

pub fn new_session(&mut self) -> Session<'_, T>

Create a new session that can be converted into a session key, with access to the underlying storage written to by the session.

Source

pub fn get(&self, index: SliceIndex) -> &[T]

Source

pub fn get_mut(&mut self, index: SliceIndex) -> &mut [T]

Source

pub fn tail_drain(&mut self, size: u32)

Drain values from the end of the buffer, regardless of which key it belongs to.

This will update the last key in the buffer

§Panics

Panics if there are no keys in the buffer

Source

pub fn clear(&mut self)

Clear the entire buffer

Trait Implementations§

Source§

impl<T: Debug> Debug for Buffer<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Buffer<T>

§

impl<T> RefUnwindSafe for Buffer<T>
where T: RefUnwindSafe,

§

impl<T> Send for Buffer<T>
where T: Send,

§

impl<T> Sync for Buffer<T>
where T: Sync,

§

impl<T> Unpin for Buffer<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Buffer<T>

§

impl<T> UnwindSafe for Buffer<T>
where T: UnwindSafe,

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 = 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.