Struct BufferWithContext 

pub struct BufferWithContext<'a> { /* private fields */ }

Owned buffer (with context)

The &MainRef context is necessary to be able to free the buffer on drop.

Implementations

impl<'a> BufferWithContext<'a>

pub unsafe fn from_parts(buffer: BufferIndex, vm: &'a MainRef) -> Self

Creates a BufferWithContext directly from a buffer index and a main reference

Safety

• The buffer index must be valid and the caller must have ownership of the buffer it corresponds to.

pub fn into_parts(self) -> (BufferIndex, &'a MainRef)

Decomposes a BufferWithContext into its component parts

After calling this the caller is responsible for ensuring the buffer gets freed, either by calling BufferWithContext::from_parts or by passing it into another function which takes ownership of it and eventually causes it to be freed.

pub fn as_buffer_ref(&mut self) -> &mut BufferRef<()>

Get a mutable reference to the buffer

Trait Implementations

impl Drop for BufferWithContext<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.