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 kind | Where the closure lives | API |
|---|---|---|
| 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 scopeImplementations§
Trait Implementations§
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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