Skip to main content

Handler

Struct Handler 

Source
pub struct Handler<T> { /* private fields */ }
Expand description

§Handler

Heap-allocated, reference-counted callback holder for callbacks the C client retains (fires later, possibly many times, from the conductor thread).

Handler<T> wraps Arc<UnsafeCell<T>>. The callback value lives on the heap and is freed only when the last clone drops. The raw clientd pointer handed to C is &T (via Handler::as_raw); C keeps firing it for as long as it holds the callback, so the Handler must outlive that — methods that register a retained callback ([AeronContext::set_error_handler], the image lifecycle handlers on async_add_subscription, set_on_available_image, …) store a clone of the Handler inside the registering resource (as a dependency), so the value is guaranteed to outlive the C side’s use of it. No manual release() is needed.

§Heap vs stack — when to reach for Handler vs a *_fn / *_once method

Callback kindWhere the closure livesAPI
Retained (C stores it; fires later / repeatedly)heap (Handler/Arc)set_error_handler(Some(Handler::new(...))), async_add_subscription(.., Some(&h), ..), poll(Some(&h), limit)
Sync / call-only (C fires it during the call, then is done)stack (borrowed FnMut, zero allocation)poll_fn(|msg, hdr| ..., limit), the generated *_once variants

Prefer the stack form (poll_fn, *_once) on the hot path: it borrows the closure for the duration of the call only, so there is no Arc, no heap allocation, and the closure may borrow local state. Reach for Handler (heap) when the callback must survive past the registering call — image lifecycle handlers, error handlers, counters callbacks, anything the conductor invokes asynchronously.

The reference count is atomic (Arc), so a Handler may be moved to another thread; it is deliberately not Sync — callbacks fire from the conductor thread and must not be shared concurrently.

§Example

use rusteron_code_gen::Handler;
let handler = Handler::new(your_value);
// the value is freed when the last clone of `handler` goes out of scope

Implementations§

Source§

impl<T> Handler<T>

Source

pub fn new(handler: T) -> Self

Source

pub fn as_raw(&self) -> *mut c_void

Source

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

Get a mutable reference to the inner value.

§Safety

Caller must ensure that no other references to the inner value are active.

Trait Implementations§

Source§

impl<T> Clone for Handler<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T> Deref for Handler<T>

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl<T: Send> Send for Handler<T>

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for Handler<T>

§

impl<T> !Sync for Handler<T>

§

impl<T> !UnwindSafe for Handler<T>

§

impl<T> Freeze for Handler<T>

§

impl<T> Unpin for Handler<T>

§

impl<T> UnsafeUnpin for Handler<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.