/rust/registry/src/index.crates.io-6f17d22bba15001f/futures-task-0.3.31/src/arc_wake.rs

Source (jump to first uncovered line)
use alloc::sync::Arc;

/// A way of waking up a specific task.
///
/// By implementing this trait, types that are expected to be wrapped in an `Arc`
/// can be converted into [`Waker`] objects.
/// Those Wakers can be used to signal executors that a task it owns
/// is ready to be `poll`ed again.
///
/// Currently, there are two ways to convert `ArcWake` into [`Waker`]:
///
/// * [`waker`](super::waker()) converts `Arc<impl ArcWake>` into [`Waker`].
/// * [`waker_ref`](super::waker_ref()) converts `&Arc<impl ArcWake>` into [`WakerRef`] that
///   provides access to a [`&Waker`][`Waker`].
///
/// [`Waker`]: std::task::Waker
/// [`WakerRef`]: super::WakerRef
// Note: Send + Sync required because `Arc<T>` doesn't automatically imply
// those bounds, but `Waker` implements them.
pub trait ArcWake: Send + Sync {
    /// Indicates that the associated task is ready to make progress and should
    /// be `poll`ed.
    ///
    /// This function can be called from an arbitrary thread, including threads which
    /// did not create the `ArcWake` based [`Waker`].
    ///
    /// Executors generally maintain a queue of "ready" tasks; `wake` should place
    /// the associated task onto this queue.
    ///
    /// [`Waker`]: std::task::Waker
    fn wake(self: Arc<Self>) {
        Self::wake_by_ref(&self)
    }

    /// Indicates that the associated task is ready to make progress and should
    /// be `poll`ed.
    ///
    /// This function can be called from an arbitrary thread, including threads which
    /// did not create the `ArcWake` based [`Waker`].
    ///
    /// Executors generally maintain a queue of "ready" tasks; `wake_by_ref` should place
    /// the associated task onto this queue.
    ///
    /// This function is similar to [`wake`](ArcWake::wake), but must not consume the provided data
    /// pointer.
    ///
    /// [`Waker`]: std::task::Waker
    fn wake_by_ref(arc_self: &Arc<Self>);
}

Coverage Report

Created: 2025-02-25 06:39

Line	Count	Source (jump to first uncovered line)
1		use alloc::sync::Arc;
2
3		/// A way of waking up a specific task.
4		///
5		/// By implementing this trait, types that are expected to be wrapped in an `Arc`
6		/// can be converted into [`Waker`] objects.
7		/// Those Wakers can be used to signal executors that a task it owns
8		/// is ready to be `poll`ed again.
9		///
10		/// Currently, there are two ways to convert `ArcWake` into [`Waker`]:
11		///
12		/// * [`waker`](super::waker()) converts `Arc<impl ArcWake>` into [`Waker`].
13		/// * [`waker_ref`](super::waker_ref()) converts `&Arc<impl ArcWake>` into [`WakerRef`] that
14		/// provides access to a [`&Waker`][`Waker`].
15		///
16		/// [`Waker`]: std::task::Waker
17		/// [`WakerRef`]: super::WakerRef
18		// Note: Send + Sync required because `Arc<T>` doesn't automatically imply
19		// those bounds, but `Waker` implements them.
20		pub trait ArcWake: Send + Sync {
21		/// Indicates that the associated task is ready to make progress and should
22		/// be `poll`ed.
23		///
24		/// This function can be called from an arbitrary thread, including threads which
25		/// did not create the `ArcWake` based [`Waker`].
26		///
27		/// Executors generally maintain a queue of "ready" tasks; `wake` should place
28		/// the associated task onto this queue.
29		///
30		/// [`Waker`]: std::task::Waker
31	0	fn wake(self: Arc<Self>) {
32	0	Self::wake_by_ref(&self)
33	0	} Unexecuted instantiation: <futures_util::stream::futures_unordered::task::Task<tls_listener::Waiting<tokio::net::tcp::listener::TcpListener, ztunnel::tls::workload::InboundAcceptor<ztunnel::proxy::inbound::InboundCertProvider>>> as futures_task::arc_wake::ArcWake>::wake Unexecuted instantiation: <futures_util::stream::futures_unordered::task::Task<futures_util::stream::futures_ordered::OrderWrapper<tokio::runtime::task::join::JoinHandle<()>>> as futures_task::arc_wake::ArcWake>::wake Unexecuted instantiation: <futures_util::stream::futures_unordered::task::Task<futures_util::stream::futures_ordered::OrderWrapper<<ztunnel::drain::internal::Signal>::start_drain_and_wait::{closure#0}>> as futures_task::arc_wake::ArcWake>::wake Unexecuted instantiation: <futures_util::stream::futures_unordered::task::Task<futures_util::future::future::Map<hickory_proto::xfer::FirstAnswerFuture<core::pin::Pin<alloc::boxed::Box<dyn futures_core::stream::Stream<Item = core::result::Result<hickory_proto::xfer::dns_response::DnsResponse, hickory_resolver::error::ResolveError>> + core::marker::Send>>>, hickory_resolver::name_server::name_server_pool::parallel_conn_loop<hickory_resolver::name_server::connection_provider::GenericConnector<ztunnel::dns::forwarder::RuntimeProviderAdaptor>>::{closure#0}::{closure#0}::{closure#0}>> as futures_task::arc_wake::ArcWake>::wake Unexecuted instantiation: <futures_util::stream::futures_unordered::task::Task<<ztunnel::identity::manager::Worker>::run::{closure#0}::{closure#2}> as futures_task::arc_wake::ArcWake>::wake Unexecuted instantiation: <futures_util::stream::futures_unordered::task::Task<futures_util::future::future::Map<hickory_proto::xfer::FirstAnswerFuture<core::pin::Pin<alloc::boxed::Box<dyn futures_core::stream::Stream<Item = core::result::Result<hickory_proto::xfer::dns_response::DnsResponse, hickory_resolver::error::ResolveError>> + core::marker::Send>>>, hickory_resolver::name_server::name_server_pool::parallel_conn_loop<hickory_resolver::name_server::connection_provider::GenericConnector<hickory_resolver::name_server::connection_provider::tokio_runtime::TokioRuntimeProvider>>::{closure#0}::{closure#0}::{closure#0}>> as futures_task::arc_wake::ArcWake>::wake Unexecuted instantiation: <_ as futures_task::arc_wake::ArcWake>::wake
34
35		/// Indicates that the associated task is ready to make progress and should
36		/// be `poll`ed.
37		///
38		/// This function can be called from an arbitrary thread, including threads which
39		/// did not create the `ArcWake` based [`Waker`].
40		///
41		/// Executors generally maintain a queue of "ready" tasks; `wake_by_ref` should place
42		/// the associated task onto this queue.
43		///
44		/// This function is similar to [`wake`](ArcWake::wake), but must not consume the provided data
45		/// pointer.
46		///
47		/// [`Waker`]: std::task::Waker
48		fn wake_by_ref(arc_self: &Arc<Self>);
49		}