Struct cacao::foundation::AutoReleasePool

pub struct AutoReleasePool(pub Id<Object>);

A wrapper around NSAutoReleasePool. The core App structures create and manage one of these, but it’s conceivable that users might need to create their own.

When this is dropped, we automatically send a drain message to the underlying pool. You can also call drain() yourself if you need to drain for whatever reason.

Tuple Fields

0: Id<Object>

Implementations

impl AutoReleasePool

pub fn new() -> Self

Creates and returns a new AutoReleasePool. You need to take care to keep this alive for as long as you need it.

pub fn drain(&self)

Drains the underlying AutoreleasePool.

pub fn run<F>(handler: F) where
    F: Fn() + 'static, 

Run a function with a one-off AutoReleasePool.

This will create a custom NSAutoreleasePool, run your handler, and automatically drain when done. This is (roughly, ish) equivalent to @autoreleasepool {} under ARC. If you need to perform Cocoa calls on a different thread, it’s important to ensure they’re backed with an autorelease pool - otherwise your memory footprint will continue to grow.

Trait Implementations

impl Debug for AutoReleasePool

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

Formats the value using the given formatter.

impl Drop for AutoReleasePool

fn drop(&mut self)

Drains the underlying NSAutoreleasePool.