Skip to main content

ScratchBuffer

Struct ScratchBuffer 

Source
pub struct ScratchBuffer<const SIZE: usize = DEFAULT_SCRATCH_SIZE> { /* private fields */ }
Expand description

Thread-local scratch buffer for temporary allocations.

Provides fast, allocation-free temporary storage that can be used in Ring 0 hot path code. The buffer is automatically reset after each event is processed.

§Usage Pattern

use laminar_core::alloc::ScratchBuffer;

fn process_event(event: &Event) {
    // Allocate temporary space from scratch buffer
    let temp = ScratchBuffer::alloc(256);
    temp.copy_from_slice(&event.data[..256]);

    // Use temp...

    // Reset at end of event processing
    ScratchBuffer::reset();
}

§Thread Safety

Each thread has its own scratch buffer. The buffer is NOT thread-safe and should only be accessed from a single thread.

§Panics

Panics if allocation request exceeds buffer capacity.

Implementations§

Source§

impl<const SIZE: usize> ScratchBuffer<SIZE>

Source

pub const fn new() -> Self

Create a new scratch buffer.

Source

pub const fn capacity(&self) -> usize

Get the total capacity of the scratch buffer.

Source

pub fn remaining(&self) -> usize

Get the number of bytes remaining.

Source

pub fn used(&self) -> usize

Get the number of bytes used.

Source

pub fn reset(&mut self)

Reset the scratch buffer for reuse.

Does NOT zero the memory - just resets the position.

Source

pub fn alloc_slice(&mut self, size: usize) -> &mut [u8]

Allocate a slice from the scratch buffer.

§Arguments
  • size - Number of bytes to allocate
§Returns

Mutable slice of the requested size.

§Panics

Panics if there isn’t enough space remaining.

Source

pub fn try_alloc_slice(&mut self, size: usize) -> Option<&mut [u8]>

Try to allocate a slice, returning None if not enough space.

Source

pub fn alloc<T: Copy + Default>(&mut self) -> &mut T

Allocate space for a value and return a mutable reference.

The space is properly aligned for the type.

§Panics

Panics if there isn’t enough space.

Source

pub fn alloc_with<T: Copy>(&mut self, value: T) -> &mut T

Allocate space for a value with initialization.

§Panics

Panics if there isn’t enough space remaining in the buffer.

Source§

impl ScratchBuffer<DEFAULT_SCRATCH_SIZE>

Static methods for accessing thread-local scratch buffer.

Source

pub fn thread_local_alloc(size: usize) -> &'static mut [u8]

Allocate from the thread-local scratch buffer.

§Arguments
  • size - Number of bytes to allocate
§Returns

Mutable slice that is valid until reset() is called.

§Panics

Panics if the requested size exceeds remaining capacity.

§Safety Note

The returned reference is only valid until the next reset() call. It’s the caller’s responsibility to ensure the slice is not used after reset.

Source

pub fn thread_local_reset()

Reset the thread-local scratch buffer.

Call this at the end of each event to reclaim space.

Source

pub fn thread_local_remaining() -> usize

Get remaining capacity in thread-local buffer.

Source

pub fn thread_local_used() -> usize

Get used bytes in thread-local buffer.

Trait Implementations§

Source§

impl<const SIZE: usize> Default for ScratchBuffer<SIZE>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<const SIZE: usize> Freeze for ScratchBuffer<SIZE>

§

impl<const SIZE: usize> RefUnwindSafe for ScratchBuffer<SIZE>

§

impl<const SIZE: usize> Send for ScratchBuffer<SIZE>

§

impl<const SIZE: usize> Sync for ScratchBuffer<SIZE>

§

impl<const SIZE: usize> Unpin for ScratchBuffer<SIZE>

§

impl<const SIZE: usize> UnwindSafe for ScratchBuffer<SIZE>

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> 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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
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<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<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,