Struct BatchedRetire 

pub struct BatchedRetire;

Batched retirement utilities.

Provides a consistent API for retirement operations. Currently delegates directly to seize’s defer_retire, which already performs internal batching.

Implementations

impl BatchedRetire

pub unsafe fn defer_value<S: ValueSlot>(ptr: *mut u8, guard: &LocalGuard<'_>)

Defer retirement of a value using S::cleanup_value_ptr.

This is the main entry point for value retirement in the tree.

Safety

• ptr must be a valid value pointer for slot type S
• ptr must not be accessed after this call

Example

if S::NEEDS_RETIREMENT {
    unsafe {
        BatchedRetire::defer_value::<S>(old_ptr, guard);
    }
}

pub unsafe fn defer_custom<T>( ptr: *mut T, cleanup_fn: unsafe fn(*mut T, &Collector), guard: &LocalGuard<'_>, )

Defer retirement with a custom cleanup function.

Use this for suffix bags, nodes, and other non-value retirements.

Safety

• ptr must be valid for the provided cleanup_fn
• ptr must not be accessed after this call
• cleanup_fn must correctly clean up the pointer

pub fn flush(guard: &LocalGuard<'_>)

Flush pending retirements to start reclamation process.

This triggers seize to process any accumulated retirements in the thread-local batch. Note that actual memory reclamation won’t happen until the guard is dropped, but this allows reclamation to proceed more quickly once the guard is released.

When to Use

• After completing a batch of mutations before starting a long read
• At natural boundaries in your workload
• When you want more predictable reclamation timing

pub const fn pending() -> usize

Get the number of pending retirements (always 0 in current implementation).

Since retirement is delegated directly to seize, there are no pending retirements at this level.

Trait Implementations

impl Debug for BatchedRetire

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

Formats the value using the given formatter.