pub struct MarkerBack<'scratchpad, BufferT, TrackingT>{ /* private fields */ }
Expand description
Scratchpad
marker for allocations from the back of the allocation
buffer.
A MarkerBack
is created when calling the mark_back()
method on a
Scratchpad
instance. Object allocations can only be made from the most
recently created MarkerFront
or MarkerBack
that is still active.
Markers are statically bound to the lifetime of the Scratchpad
from
which they are created, ensuring that no dangling references are left when
the Scratchpad
is dropped.
This struct wraps Marker
trait methods to avoid the need to import
Marker
into scope.
Implementations§
Source§impl<'scratchpad, BufferT, TrackingT> MarkerBack<'scratchpad, BufferT, TrackingT>
impl<'scratchpad, BufferT, TrackingT> MarkerBack<'scratchpad, BufferT, TrackingT>
Sourcepub fn allocate<T>(&self, value: T) -> Result<Allocation<'_, T>, Error<(T,)>>
pub fn allocate<T>(&self, value: T) -> Result<Allocation<'_, T>, Error<(T,)>>
Allocates space for the given value, moving it into the allocation.
§Examples
use scratchpad::Scratchpad;
let scratchpad = Scratchpad::<[u64; 1], [usize; 1]>::new([0], [0]);
let marker = scratchpad.mark_back().unwrap();
let x = marker.allocate(3.14159).unwrap();
assert_eq!(*x, 3.14159);
Sourcepub fn allocate_default<T: Default>(
&self,
) -> Result<Allocation<'_, T>, Error<()>>
pub fn allocate_default<T: Default>( &self, ) -> Result<Allocation<'_, T>, Error<()>>
Allocates space for a value, initializing it to its default.
§Examples
use scratchpad::Scratchpad;
let scratchpad = Scratchpad::<[u64; 1], [usize; 1]>::new([0], [0]);
let marker = scratchpad.mark_back().unwrap();
let x = marker.allocate_default::<f64>().unwrap();
assert_eq!(*x, 0.0);
Sourcepub unsafe fn allocate_uninitialized<T>(
&self,
) -> Result<Allocation<'_, T>, Error<()>>
pub unsafe fn allocate_uninitialized<T>( &self, ) -> Result<Allocation<'_, T>, Error<()>>
Allocates uninitialized space for the given type.
§Safety
Since memory for the allocated data is uninitialized, it can
potentially be in an invalid state for a given type, leading to
undefined program behavior. It is recommended that one of the safe
allocate*()
methods are used instead if possible.
§Examples
use scratchpad::Scratchpad;
let scratchpad = Scratchpad::<[u64; 1], [usize; 1]>::new([0], [0]);
let marker = scratchpad.mark_back().unwrap();
let mut x = unsafe { marker.allocate_uninitialized().unwrap() };
*x = 3.14159;
assert_eq!(*x, 3.14159);
Sourcepub fn allocate_array<T: Clone>(
&self,
len: usize,
value: T,
) -> Result<Allocation<'_, [T]>, Error<(T,)>>
pub fn allocate_array<T: Clone>( &self, len: usize, value: T, ) -> Result<Allocation<'_, [T]>, Error<(T,)>>
Allocates space for an array, initializing each element with the given value.
§Examples
use scratchpad::Scratchpad;
let scratchpad = Scratchpad::<[u64; 3], [usize; 1]>::new([0; 3], [0]);
let marker = scratchpad.mark_back().unwrap();
let x = marker.allocate_array(3, 3.14159).unwrap();
assert_eq!(*x, [3.14159, 3.14159, 3.14159]);
Sourcepub fn allocate_array_default<T: Default>(
&self,
len: usize,
) -> Result<Allocation<'_, [T]>, Error<()>>
pub fn allocate_array_default<T: Default>( &self, len: usize, ) -> Result<Allocation<'_, [T]>, Error<()>>
Allocates space for an array, initializing each element to its default value.
§Examples
use scratchpad::Scratchpad;
let scratchpad = Scratchpad::<[u64; 3], [usize; 1]>::new([0; 3], [0]);
let marker = scratchpad.mark_back().unwrap();
let x = marker.allocate_array_default::<f64>(3).unwrap();
assert_eq!(*x, [0.0, 0.0, 0.0]);
Sourcepub fn allocate_array_with<T, F: FnMut(usize) -> T>(
&self,
len: usize,
func: F,
) -> Result<Allocation<'_, [T]>, Error<()>>
pub fn allocate_array_with<T, F: FnMut(usize) -> T>( &self, len: usize, func: F, ) -> Result<Allocation<'_, [T]>, Error<()>>
Allocates space for an array, initializing each element with the result of a function.
The function func
takes a single parameter containing the index of
the element being initialized.
§Examples
use scratchpad::Scratchpad;
let scratchpad = Scratchpad::<[u64; 3], [usize; 1]>::new([0; 3], [0]);
let marker = scratchpad.mark_back().unwrap();
let x = marker.allocate_array_with(3, |index| index as f64).unwrap();
assert_eq!(*x, [0.0, 1.0, 2.0]);
Sourcepub unsafe fn allocate_array_uninitialized<T>(
&self,
len: usize,
) -> Result<Allocation<'_, [T]>, Error<()>>
pub unsafe fn allocate_array_uninitialized<T>( &self, len: usize, ) -> Result<Allocation<'_, [T]>, Error<()>>
Allocates uninitialized space for an array of the given type.
§Safety
Since memory for the allocated data is uninitialized, it can
potentially be in an invalid state for a given type, leading to
undefined program behavior. It is recommended that one of the safe
allocate*()
methods are used instead if possible.
§Examples
use scratchpad::Scratchpad;
let scratchpad = Scratchpad::<[u64; 3], [usize; 1]>::new([0; 3], [0]);
let marker = scratchpad.mark_back().unwrap();
let mut x = unsafe {
marker.allocate_array_uninitialized(3).unwrap()
};
x[0] = 3.14159;
x[1] = 4.14159;
x[2] = 5.14159;
assert_eq!(*x, [3.14159, 4.14159, 5.14159]);
Sourcepub fn allocate_slice<T, U>(
&self,
values: U,
) -> Result<Allocation<'_, T>, Error<(U,)>>
pub fn allocate_slice<T, U>( &self, values: U, ) -> Result<Allocation<'_, T>, Error<(U,)>>
Allocates a slice, initializing its contents by moving the given values into the allocation.
§Examples
use scratchpad::Scratchpad;
let scratchpad = Scratchpad::<[u64; 3], [usize; 1]>::static_new();
let marker = scratchpad.mark_back().unwrap();
let values = [3.14159, 4.14159, 5.14159];
let allocation = marker.allocate_slice(values).unwrap();
let allocation_slice: &[f64] = &*allocation;
assert_eq!(*allocation_slice, [3.14159, 4.14159, 5.14159]);
Sourcepub fn allocate_slice_clone<T, U>(
&self,
values: U,
) -> Result<Allocation<'_, T>, Error<()>>
pub fn allocate_slice_clone<T, U>( &self, values: U, ) -> Result<Allocation<'_, T>, Error<()>>
Allocates a copy of a slice by cloning each individual element.
§Examples
use scratchpad::Scratchpad;
let scratchpad = Scratchpad::<[u8; 32], [usize; 1]>::static_new();
let marker = scratchpad.mark_back().unwrap();
let message = "foo";
let allocation = marker.allocate_slice_clone(message).unwrap();
assert_eq!(&*allocation, "foo");
Sourcepub fn allocate_slice_copy<T, U>(
&self,
values: U,
) -> Result<Allocation<'_, T>, Error<()>>
pub fn allocate_slice_copy<T, U>( &self, values: U, ) -> Result<Allocation<'_, T>, Error<()>>
Allocates a copy of a slice by performing a fast copy (equivalent to
C’s memcpy()
function) into the new allocation.
§Examples
use scratchpad::Scratchpad;
let scratchpad = Scratchpad::<[u8; 32], [usize; 1]>::static_new();
let marker = scratchpad.mark_back().unwrap();
let message = "foo";
let allocation = marker.allocate_slice_copy(message).unwrap();
assert_eq!(&*allocation, "foo");
Sourcepub fn prepend<'marker, T, U, V>(
&'marker self,
allocation: Allocation<'marker, U>,
values: V,
) -> Result<Allocation<'marker, T>, Error<(Allocation<'marker, U>, V)>>
pub fn prepend<'marker, T, U, V>( &'marker self, allocation: Allocation<'marker, U>, values: V, ) -> Result<Allocation<'marker, T>, Error<(Allocation<'marker, U>, V)>>
Extends an allocation by moving values onto its start, converting the allocation to a slice if necessary.
The following requirements must be met to allow elements to be prepended:
- The marker must be the most recently created back marker from its scratchpad.
- The allocation must contain a scalar, array, or slice of the type being pushed.
- The data being pushed must be a scalar, array, boxed slice, or vector of the same type.
- The allocation must be the most recent allocation made from this marker, even if other, more recent allocations have been released.
§Examples
use scratchpad::Scratchpad;
let scratchpad = Scratchpad::<[u32; 5], [usize; 1]>::static_new();
let marker = scratchpad.mark_back().unwrap();
let a = marker.allocate([3.14159f32, 2.71828f32]).unwrap();
let ab = marker.prepend(a, [0.70711f32]).unwrap();
assert_eq!(*ab, [0.70711f32, 3.14159f32, 2.71828f32]);
let abc = marker.prepend(ab, vec![0.57722f32, 1.61803f32]).unwrap();
assert_eq!(
*abc,
[0.57722f32, 1.61803f32, 0.70711f32, 3.14159f32, 2.71828f32],
);
Sourcepub fn prepend_clone<'marker, T, U, V>(
&'marker self,
allocation: Allocation<'marker, U>,
values: V,
) -> Result<Allocation<'marker, T>, Error<(Allocation<'marker, U>,)>>where
T: ConcatenateSlice + ?Sized,
<T as SliceLike>::Element: Clone,
U: IntoMutSliceLikePtr<T> + ?Sized,
V: SliceSource<T>,
pub fn prepend_clone<'marker, T, U, V>(
&'marker self,
allocation: Allocation<'marker, U>,
values: V,
) -> Result<Allocation<'marker, T>, Error<(Allocation<'marker, U>,)>>where
T: ConcatenateSlice + ?Sized,
<T as SliceLike>::Element: Clone,
U: IntoMutSliceLikePtr<T> + ?Sized,
V: SliceSource<T>,
Extends an allocation by cloning values onto its start, converting the allocation to a slice if necessary.
The following requirements must be met to allow elements to be prepended:
- The marker must be the most recently created back marker from its scratchpad.
- The allocation must contain a scalar, array, or slice of the type being pushed.
- The data being pushed must be a scalar, array, boxed slice, or vector of the same type.
- The allocation must be the most recent allocation made from this marker, even if other, more recent allocations have been released.
Note that the values
parameter is consumed as part of the allocation
process and cannot be returned on error.
§Examples
use scratchpad::{Allocation, Scratchpad};
let scratchpad = Scratchpad::<[u32; 5], [usize; 1]>::static_new();
let marker = scratchpad.mark_back().unwrap();
let a: Allocation<[f32]> = marker.allocate([3.14159f32, 2.71828f32])
.unwrap()
.into_slice_like_allocation();
let ab = marker.prepend_clone(a, &[0.57722f32, 1.61803f32][..])
.unwrap();
assert_eq!(*ab, [0.57722f32, 1.61803f32, 3.14159f32, 2.71828f32]);
Sourcepub fn prepend_copy<'marker, T, U, V>(
&'marker self,
allocation: Allocation<'marker, U>,
values: V,
) -> Result<Allocation<'marker, T>, Error<(Allocation<'marker, U>,)>>where
T: ConcatenateSlice + ?Sized,
<T as SliceLike>::Element: Copy,
U: IntoMutSliceLikePtr<T> + ?Sized,
V: SliceSource<T>,
pub fn prepend_copy<'marker, T, U, V>(
&'marker self,
allocation: Allocation<'marker, U>,
values: V,
) -> Result<Allocation<'marker, T>, Error<(Allocation<'marker, U>,)>>where
T: ConcatenateSlice + ?Sized,
<T as SliceLike>::Element: Copy,
U: IntoMutSliceLikePtr<T> + ?Sized,
V: SliceSource<T>,
Extends an allocation by copying values onto its start, converting the allocation to a slice if necessary.
The following requirements must be met to allow elements to be prepended:
- The marker must be the most recently created back marker from its scratchpad.
- The allocation must contain a scalar, array, or slice of the type being pushed.
- The data being pushed must be a scalar, array, boxed slice, or vector of the same type.
- The allocation must be the most recent allocation made from this marker, even if other, more recent allocations have been released.
Note that the values
parameter is consumed as part of the allocation
process and cannot be returned on error.
§Examples
use scratchpad::{Allocation, Scratchpad};
let scratchpad = Scratchpad::<[u32; 5], [usize; 1]>::static_new();
let marker = scratchpad.mark_back().unwrap();
let a: Allocation<[f32]> = marker.allocate([3.14159f32, 2.71828f32])
.unwrap()
.into_slice_like_allocation();
let ab = marker.prepend_copy(a, &[0.57722f32, 1.61803f32][..])
.unwrap();
assert_eq!(*ab, [0.57722f32, 1.61803f32, 3.14159f32, 2.71828f32]);
Sourcepub fn concat_slices<T, U>(
&self,
values: U,
) -> Result<Allocation<'_, T>, Error<(U,)>>
pub fn concat_slices<T, U>( &self, values: U, ) -> Result<Allocation<'_, T>, Error<(U,)>>
Combines each of the provided slices into a single slice allocated from this marker, moving the slice values into the new allocation.
§Examples
use scratchpad::Scratchpad;
let scratchpad = Scratchpad::<[u8; 16], [usize; 1]>::static_new();
let marker = scratchpad.mark_back().unwrap();
let combined = marker.concat_slices(("Hello,", " world", "!"))
.unwrap();
assert_eq!(&*combined, "Hello, world!");
Sourcepub fn concat_slices_clone<T, U>(
&self,
values: U,
) -> Result<Allocation<'_, T>, Error<()>>
pub fn concat_slices_clone<T, U>( &self, values: U, ) -> Result<Allocation<'_, T>, Error<()>>
Combines cloned copies of each of the provided slices into a single slice allocated from this marker.
§Examples
use scratchpad::Scratchpad;
let scratchpad = Scratchpad::<[u8; 16], [usize; 1]>::static_new();
let marker = scratchpad.mark_back().unwrap();
let combined = marker.concat_slices_clone(("Hello,", " world", "!"))
.unwrap();
assert_eq!(&*combined, "Hello, world!");
Sourcepub fn concat_slices_copy<T, U>(
&self,
values: U,
) -> Result<Allocation<'_, T>, Error<()>>
pub fn concat_slices_copy<T, U>( &self, values: U, ) -> Result<Allocation<'_, T>, Error<()>>
Combines copies of each of the provided slices into a single slice allocated from this marker.
Slices are copied by performing a fast memory copy from each of the
source slices (equivalent to C’s memcpy()
function).
§Examples
use scratchpad::Scratchpad;
let scratchpad = Scratchpad::<[u8; 16], [usize; 1]>::static_new();
let marker = scratchpad.mark_back().unwrap();
let combined = marker.concat_slices_copy(("Hello,", " world", "!"))
.unwrap();
assert_eq!(&*combined, "Hello, world!");
Trait Implementations§
Source§impl<'scratchpad, BufferT, TrackingT> Debug for MarkerBack<'scratchpad, BufferT, TrackingT>
impl<'scratchpad, BufferT, TrackingT> Debug for MarkerBack<'scratchpad, BufferT, TrackingT>
Source§impl<'scratchpad, BufferT, TrackingT> Drop for MarkerBack<'scratchpad, BufferT, TrackingT>
impl<'scratchpad, BufferT, TrackingT> Drop for MarkerBack<'scratchpad, BufferT, TrackingT>
Source§impl<'scratchpad, BufferT, TrackingT> Marker for MarkerBack<'scratchpad, BufferT, TrackingT>
impl<'scratchpad, BufferT, TrackingT> Marker for MarkerBack<'scratchpad, BufferT, TrackingT>
Source§fn allocate<T>(&self, value: T) -> Result<Allocation<'_, T>, Error<(T,)>>
fn allocate<T>(&self, value: T) -> Result<Allocation<'_, T>, Error<(T,)>>
Source§fn allocate_default<T: Default>(&self) -> Result<Allocation<'_, T>, Error<()>>
fn allocate_default<T: Default>(&self) -> Result<Allocation<'_, T>, Error<()>>
Source§unsafe fn allocate_uninitialized<T>(
&self,
) -> Result<Allocation<'_, T>, Error<()>>
unsafe fn allocate_uninitialized<T>( &self, ) -> Result<Allocation<'_, T>, Error<()>>
Source§fn allocate_array<T: Clone>(
&self,
len: usize,
value: T,
) -> Result<Allocation<'_, [T]>, Error<(T,)>>
fn allocate_array<T: Clone>( &self, len: usize, value: T, ) -> Result<Allocation<'_, [T]>, Error<(T,)>>
Source§fn allocate_array_default<T: Default>(
&self,
len: usize,
) -> Result<Allocation<'_, [T]>, Error<()>>
fn allocate_array_default<T: Default>( &self, len: usize, ) -> Result<Allocation<'_, [T]>, Error<()>>
Source§fn allocate_array_with<T, F: FnMut(usize) -> T>(
&self,
len: usize,
func: F,
) -> Result<Allocation<'_, [T]>, Error<()>>
fn allocate_array_with<T, F: FnMut(usize) -> T>( &self, len: usize, func: F, ) -> Result<Allocation<'_, [T]>, Error<()>>
Source§unsafe fn allocate_array_uninitialized<T>(
&self,
len: usize,
) -> Result<Allocation<'_, [T]>, Error<()>>
unsafe fn allocate_array_uninitialized<T>( &self, len: usize, ) -> Result<Allocation<'_, [T]>, Error<()>>
Source§fn allocate_slice<T, U>(
&self,
values: U,
) -> Result<Allocation<'_, T>, Error<(U,)>>
fn allocate_slice<T, U>( &self, values: U, ) -> Result<Allocation<'_, T>, Error<(U,)>>
Source§fn allocate_slice_clone<T, U>(
&self,
values: U,
) -> Result<Allocation<'_, T>, Error<()>>
fn allocate_slice_clone<T, U>( &self, values: U, ) -> Result<Allocation<'_, T>, Error<()>>
Source§fn allocate_slice_copy<T, U>(
&self,
values: U,
) -> Result<Allocation<'_, T>, Error<()>>
fn allocate_slice_copy<T, U>( &self, values: U, ) -> Result<Allocation<'_, T>, Error<()>>
memcpy()
function) into the new allocation. Read more