Struct BailoutGuard 

pub struct BailoutGuard<T> { /* private fields */ }

A guard that drops its value even if a PHP bailout skips its frame.

BailoutGuard::new moves the value to the heap and registers a cleanup entry with the innermost try_catch frame. If that frame catches a bailout, it drops the value. If you drop the guard, the guard releases the entry and drops the value.

Performance

BailoutGuard::new makes one heap allocation. Use it only for values that must be released: file handles, network connections, locks. Do not wrap simple values.

Implementations

impl<T: 'static> BailoutGuard<T>

pub fn new(value: T) -> Self

Wraps value in a new guard.

The value moves to the heap. The guard registers a cleanup entry with the innermost try_catch frame.

pub fn get(&self) -> &T

Returns a reference to the wrapped value.

pub fn get_mut(&mut self) -> &mut T

Returns a mutable reference to the wrapped value.

pub fn into_inner(self) -> T

Consumes the guard and returns the value.

The guard releases its cleanup entry.

Trait Implementations

impl<T> Deref for BailoutGuard<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for BailoutGuard<T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T> Drop for BailoutGuard<T>

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.