pub struct NotifyHandle { /* fields omitted */ }A NotifyHandle is the core value through which notifications are routed
in the futures crate.
All instances of Task will contain a NotifyHandle handle internally.
This handle itself contains a trait object pointing to an instance of the
Notify trait, allowing notifications to get routed through it.
The NotifyHandle type internally does not codify any particular memory
management strategy. Internally it contains an instance of *mut UnsafeNotify, and more details about that trait can be found on its own
documentation. Consequently, though, the one constructor of this type,
NotifyHandle::new, is unsafe to call. It is not recommended to call
this constructor directly.
If you're working with the standard library then it's recommended to
work with the Arc type. If you have a struct, T, which implements the
Notify trait, then you can construct this with
NotifyHandle::from(t: Arc<T>). The coercion to UnsafeNotify will
happen automatically and safely for you.
When working externally from the standard library it's recommended to
provide a similar safe constructor for your custom type as opposed to
recommending an invocation of NotifyHandle::new directly.
Constructs a new NotifyHandle directly.
Note that most code will not need to call this. Implementers of the
UnsafeNotify trait will typically provide a wrapper that calls this
but you otherwise shouldn't call it directly.
If you're working with the standard library then it's recommended to
use the NotifyHandle::from function instead which works with the safe
Arc type and the safe Notify trait.
Invokes the underlying instance of Notify with the provided id.
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Executes the destructor for this type. Read more