Struct OutFrame 

pub struct OutFrame<'a, T> { /* private fields */ }

A potentially initialized frame. Used when initializing a new frame in the main loop.

Implementations

impl<'a, T> OutFrame<'a, T>

pub fn new_init(slot: &'a mut T) -> Self

Creates a new initialized OutFrame from a mutable reference to a type T.

pub fn new_uninit(slot: &'a mut MaybeUninit<T>) -> Self

Creates a new uninitialized OutFrame from a mutable reference to a MaybeUninit<T>.

pub unsafe fn new_maybe_uninit(ptr: *mut T, init: bool) -> Self

Creates a new OutFrame from a raw pointer to a type T.

Safety

This method is unsafe because it assumes that the pointer is valid and points to a location where a type T can be stored. It also assumes that the init flag correctly reflects whether the type T has been initialized or not.

pub fn get(&mut self, f: impl FnOnce() -> T) -> &mut T

Returns a mutable reference to the type T, initializing it if it hasn’t been initialized yet.

pub unsafe fn get_unchecked(&mut self) -> &mut T

Returns a mutable reference to the type T, without checking if it has been initialized.

Safety

This method is unsafe because it assumes that the OutFrame has been initialized before use.

pub fn consume(self) -> FrameToken

Consumes the OutFrame, returning a FrameToken that indicates the frame has been initialized.