Struct BailoutGuard 

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

A guard that ensures a value is dropped even if PHP bailout occurs.

BailoutGuard heap-allocates the wrapped value and registers a cleanup callback. If a bailout occurs, the cleanup runs before the bailout is re-triggered. If the guard is dropped normally, the cleanup is cancelled and the value is dropped.

Performance Note

This incurs a heap allocation. Only use for values that absolutely must be cleaned up (file handles, network connections, locks, etc.). For simple values, the overhead isn’t worth it.

Implementations

impl<T: 'static> BailoutGuard<T>

pub fn new(value: T) -> Self

Creates a new BailoutGuard wrapping the given value.

The value is heap-allocated and a cleanup callback is registered. If a bailout occurs, the value will be dropped. If this guard is dropped normally, the value is dropped and the cleanup is cancelled.

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 wrapped value.

The cleanup callback is cancelled.

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.

impl<T: Send> Send for BailoutGuard<T>