Struct Update 

pub struct Update<'alloc, 's> { /* private fields */ }

An in-progress render state update.

This token is returned by RenderState::begin_update and keeps the render state borrowed until Self::end completes the deferred update work. This makes it impossible to read from the render state while it is incomplete.

Implementations

impl<'alloc, 's> Update<'alloc, 's>

pub fn end(self) -> Result<Snapshot<'alloc, 's>>

Complete a prior RenderState::begin_update call by performing any deferred work.

This only reads and writes memory owned by the render state, so it is safe to call while the terminal is being modified. Consumes the update token and returns a snapshot that can be read to draw the frame.

Trait Implementations

impl<'alloc, 's> Debug for Update<'alloc, 's>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Update<'_, '_>

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.