Explorar el Código

doc: mention futures-util in use_coroutine hook

Miles Murgaw hace 2 años
padre
commit
d059b2bc05
Se han modificado 1 ficheros con 4 adiciones y 0 borrados
  1. 4 0
      packages/hooks/src/usecoroutine.rs

+ 4 - 0
packages/hooks/src/usecoroutine.rs

@@ -33,6 +33,10 @@ use std::future::Future;
 /// However, you must plan out your own concurrency and synchronization. If you
 /// don't care about actions in your app being synchronized, you can use [`use_callback`]
 /// hook to spawn multiple tasks and run them concurrently.
+/// 
+/// ### Notice
+/// In order to use ``rx.next().await``, you will need to extend the ``Stream`` trait (used by ``UnboundedReceiver``) 
+/// by adding the ``futures-util`` crate as a dependency and adding ``StreamExt`` into scope via ``use futures_util::stream::StreamExt;``
 ///
 /// ## Example
 ///