Struct ManagedCResource 

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

A custom struct for managing C resources with automatic cleanup.

It handles initialisation and clean-up of the resource and ensures that resources are properly released when they go out of scope. All teardown goes through the single cleanup closure (if set), which is the FFI close function (e.g. aeron_close). The Rc dependency graph ensures parents outlive children structurally — you cannot race aeron_close ahead of a live child handle.

Implementations

impl<T> ManagedCResource<T>

pub fn new( init: impl FnOnce(*mut *mut T) -> i32, cleanup: Option<CleanupBox<T>>, cleanup_struct: bool, ) -> Result<Self, AeronCError>

Creates a new ManagedCResource with a given initializer and cleanup function.

The initializer is a closure that attempts to initialize the resource. If initialization fails, the initializer should return an error code. The cleanup function is used to release the resource when it’s no longer needed. cleanup_struct where it should clean up the struct in rust

pub fn initialise( init: impl FnOnce(*mut *mut T) -> i32 + Sized, ) -> Result<*mut T, AeronCError>

pub fn get(&self) -> *mut T

Gets a raw pointer to the resource.

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

Mutable access to the underlying C struct, minted from &self.

Safety

No other reference (& or &mut) to the underlying struct may be alive while the returned &mut is in use.

pub fn add_dependency<D: Any>(&self, dep: D)

pub fn get_dependency<V: Clone + 'static>(&self) -> Option<V>

pub fn is_resource_released(&self) -> bool

pub fn mark_resource_released(&self)

Trait Implementations

impl<T> Debug for ManagedCResource<T>

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

Formats the value using the given formatter.

impl<T> Drop for ManagedCResource<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.