Struct RecordingGuard

pub(crate) struct RecordingGuard<'a> {
    inner: &'a mut CommandEncoderStatus,
}

A guard to enforce error reporting, for a CommandBuffer in the Recording state.

An RecordingGuard holds a mutable reference to a CommandEncoderStatus that has been verified to be in the Recording state. The RecordingGuard dereferences mutably to the CommandBufferMutable that the status holds.

Dropping an RecordingGuard sets the CommandBuffer’s state to CommandEncoderStatus::Error. If your use of the guard was successful, call its mark_successful method to dispose of it.

Fields

inner: &'a mut CommandEncoderStatus

Implementations

impl<'a> RecordingGuard<'a>

pub(crate) fn mark_successful(self)

fn record<F: FnOnce(&mut CommandBufferMutable) -> Result<(), E>, E: Clone + Into<CommandEncoderError>>( self, f: F, )

pub(crate) fn record_as_hal_mut<T, F: FnOnce(Option<&mut CommandBufferMutable>) -> T>( self, f: F, ) -> T

Special version of record used by command_encoder_as_hal_mut. This version takes an infallible recording closure.

Methods from Deref<Target = CommandBufferMutable>

pub(crate) fn validate_acceleration_structure_actions( &self, snatch_guard: &SnatchGuard<'_>, command_index_guard: &mut RwLockWriteGuard<'_, CommandIndices>, ) -> Result<(), ValidateAsActionsError>

Trait Implementations

impl<'a> Deref for RecordingGuard<'a>

type Target = CommandBufferMutable

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> DerefMut for RecordingGuard<'a>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a> Drop for RecordingGuard<'a>

fn drop(&mut self)

Executes the destructor for this type.