Struct FrameMemory

pub struct FrameMemory {
    allocator: Option<NonNull<FrameInnerAllocator>>,
    references_created: UnsafeCell<i32>,
}

The backing storage for FrameAllocator

This object is meant to be stored in the built frame and must not be dropped or recycled before all allocations have been deallocated and all FrameAllocators have been dropped. In other words, drop or recycle this after dropping the rest of the built frame.

Fields

allocator: Option<NonNull<FrameInnerAllocator>>

Safety: The pointed FrameInnerAllocator must not move or be deallocated while there are live FrameAllocators pointing to it. This is ensured by respecting that the FrameMemory is dropped last and by the FrameInnerAllocator not being exposed to the outside world. It is also checked at runtime via the reference count.

references_created: UnsafeCell<i32>

The number of FrameAllocators created during the current frame. This is used to compare aganst the inner allocator’s dropped references counter to check that references have all been dropped before freeing or recycling the memory.

Implementations

impl FrameMemory

pub fn fallback() -> Self

Creates a fallback FrameMemory that uses the global allocator.

This should only be used for testing purposes and to handle the deserialization of webrender recordings.

pub fn new(pool: Arc<ChunkPool>) -> Self

Panics

A FrameMemory must not be dropped until all of the associated FrameAllocators as well as their allocations have been dropped, otherwise the FrameMemory::drop will panic.

pub fn allocator(&self) -> FrameAllocator

Create a FrameAllocator for the current frame.

pub fn new_vec<T>(&self) -> Vec<T, FrameAllocator>

Shorthand for creating a FrameVec.

pub fn new_vec_with_capacity<T>(&self, cap: usize) -> Vec<T, FrameAllocator>

Shorthand for creating a FrameVec.

pub fn assert_memory_reusable(&self)

Panics if there are still live allocations or FrameAllocators.

pub fn begin_frame(&mut self, id: FrameId)

Must be called at the beginning of each frame before creating any FrameAllocator.

pub fn get_stats(&self) -> Stats

Trait Implementations

impl Drop for FrameMemory

fn drop(&mut self)

Executes the destructor for this type.

impl Serialize for FrameMemory

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Send for FrameMemory