Struct moveit::drop_flag::TrappedFlag

pub struct TrappedFlag { /* private fields */ }

An RAII trap that ensures a drop flag is correctly cleared.

This type is similar to a DroppingFlag, except that it does not wrap a value and rather than leaking memory aborts the program if its flag is not cleared.

This type is useful for safely constructing MoveRefs.

Implementations

impl TrappedFlag

pub fn new() -> Self

Creates a new trap with a dead flag.

pub fn flag(&self) -> DropFlag<'_>

Returns a reference to the DropFlag.

pub fn assert_cleared(&self)

Preemptively checks that this flag has been cleared.

Aborts (rather than panicking!) if the assertion fails.

Trait Implementations

impl Default for TrappedFlag

fn default() -> Self

Returns the “default value” for a type.

impl Drop for TrappedFlag

fn drop(&mut self)

Executes the destructor for this type.