[−][src]Struct futures::executor::NotifyHandle
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.
Methods
impl NotifyHandle
[src]
pub unsafe fn new(inner: *mut dyn UnsafeNotify) -> NotifyHandle
[src]
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.
pub fn notify(&self, id: usize)
[src]
Invokes the underlying instance of Notify
with the provided id
.
Trait Implementations
impl<T> From<Arc<T>> for NotifyHandle where
T: Notify + 'static,
[src]
T: Notify + 'static,
fn from(rc: Arc<T>) -> NotifyHandle
[src]
impl<T: Notify> From<&'static T> for NotifyHandle
[src]
fn from(src: &'static T) -> NotifyHandle
[src]
impl Debug for NotifyHandle
[src]
impl Drop for NotifyHandle
[src]
impl Send for NotifyHandle
[src]
impl Sync for NotifyHandle
[src]
impl Clone for NotifyHandle
[src]
fn clone(&self) -> Self
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Auto Trait Implementations
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,