Struct Cleaner

pub struct Cleaner { /* private fields */ }

Available on crate feature cleaners only.

A type capable of registering cleaning actions.

All the cleaning actions registered in a Cleaner are run when it is dropped, unless they have been manually executed before.

Implementations

impl Cleaner

pub fn new() -> Cleaner

Creates a new Cleaner.

pub fn register(&self, action: impl FnOnce() + 'static) -> Cleanable

Registers a new cleaning action inside a Cleaner.

This method returns a Cleanable, which can be used to manually run the cleaning action.

Avoiding memory leaks

Usually, Cleaners are stored inside a cycle-collected object. Make sure to never capture a reference to the container object inside the action closure, otherwise the object will be leaked and the cleaning action will never be executed.

Trait Implementations

impl Debug for Cleaner

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

Formats the value using the given formatter.

impl Default for Cleaner

fn default() -> Self

Returns the “default value” for a type.

impl Finalize for Cleaner

fn finalize(&self)

The finalizer, which is called after an object becomes garbage and before droping it.

impl Trace for Cleaner

fn trace(&self, _: &mut Context<'_>)

Traces the contained Ccs. See Trace for more information.