// Take a look at the license at the top of the repository in the LICENSE file. use std::{marker::Unpin, pin, pin::Pin, time::Duration}; use futures_channel::{mpsc, oneshot}; use futures_core::{ future::{FusedFuture, Future}, stream::{FusedStream, Stream}, task, task::Poll, }; use crate::{ControlFlow, MainContext, Priority, Source}; // rustdoc-stripper-ignore-next /// Represents a `Future` around a `glib::Source`. The future will /// be resolved once the source has provided a value pub struct SourceFuture { create_source: Option, source: Option<(Source, oneshot::Receiver)>, } impl SourceFuture where F: FnOnce(oneshot::Sender) -> Source + 'static, { // rustdoc-stripper-ignore-next /// Create a new `SourceFuture` /// /// The provided closure should return a newly created `glib::Source` when called /// and pass the value provided by the source to the oneshot sender that is passed /// to the closure. pub fn new(create_source: F) -> SourceFuture { SourceFuture { create_source: Some(create_source), source: None, } } } impl Unpin for SourceFuture {} impl Future for SourceFuture where F: FnOnce(oneshot::Sender) -> Source + 'static, { type Output = T; fn poll(mut self: pin::Pin<&mut Self>, ctx: &mut task::Context) -> Poll { let SourceFuture { ref mut create_source, ref mut source, .. } = *self; if let Some(create_source) = create_source.take() { let main_context = MainContext::ref_thread_default(); assert!( main_context.is_owner(), "Spawning futures only allowed if the thread is owning the MainContext" ); // Channel for sending back the Source result to our future here. // // In theory, we could directly continue polling the // corresponding task from the Source callback, // however this would break at the very least // the g_main_current_source() API. let (send, recv) = oneshot::channel(); let s = create_source(send); s.attach(Some(&main_context)); *source = Some((s, recv)); } // At this point we must have a receiver let res = { let &mut (_, ref mut receiver) = source.as_mut().unwrap(); Pin::new(receiver).poll(ctx) }; #[allow(clippy::match_wild_err_arm)] match res { Poll::Ready(Err(_)) => panic!("Source sender was unexpectedly closed"), Poll::Ready(Ok(v)) => { // Get rid of the reference to the source, it triggered let _ = source.take(); Poll::Ready(v) } Poll::Pending => Poll::Pending, } } } impl FusedFuture for SourceFuture where F: FnOnce(oneshot::Sender) -> Source + 'static, { fn is_terminated(&self) -> bool { self.create_source.is_none() && self .source .as_ref() .map_or(true, |(_, receiver)| receiver.is_terminated()) } } impl Drop for SourceFuture { fn drop(&mut self) { // Get rid of the source, we don't care anymore if it still triggers if let Some((source, _)) = self.source.take() { source.destroy(); } } } // rustdoc-stripper-ignore-next /// Create a `Future` that will resolve after the given number of milliseconds. /// /// The `Future` must be spawned on an `Executor` backed by a `glib::MainContext`. pub fn timeout_future(value: Duration) -> Pin + Send + 'static>> { timeout_future_with_priority(crate::Priority::default(), value) } // rustdoc-stripper-ignore-next /// Create a `Future` that will resolve after the given number of milliseconds. /// /// The `Future` must be spawned on an `Executor` backed by a `glib::MainContext`. pub fn timeout_future_with_priority( priority: Priority, value: Duration, ) -> Pin + Send + 'static>> { Box::pin(SourceFuture::new(move |send| { let mut send = Some(send); crate::timeout_source_new(value, None, priority, move || { let _ = send.take().unwrap().send(()); ControlFlow::Break }) })) } // rustdoc-stripper-ignore-next /// Create a `Future` that will resolve after the given number of seconds. /// /// The `Future` must be spawned on an `Executor` backed by a `glib::MainContext`. pub fn timeout_future_seconds(value: u32) -> Pin + Send + 'static>> { timeout_future_seconds_with_priority(crate::Priority::default(), value) } // rustdoc-stripper-ignore-next /// Create a `Future` that will resolve after the given number of seconds. /// /// The `Future` must be spawned on an `Executor` backed by a `glib::MainContext`. pub fn timeout_future_seconds_with_priority( priority: Priority, value: u32, ) -> Pin + Send + 'static>> { Box::pin(SourceFuture::new(move |send| { let mut send = Some(send); crate::timeout_source_new_seconds(value, None, priority, move || { let _ = send.take().unwrap().send(()); ControlFlow::Break }) })) } // rustdoc-stripper-ignore-next /// Create a `Future` that will resolve once the child process with the given pid exits /// /// The `Future` will resolve to the pid of the child process and the exit code. /// /// The `Future` must be spawned on an `Executor` backed by a `glib::MainContext`. pub fn child_watch_future( pid: crate::Pid, ) -> Pin + Send + 'static>> { child_watch_future_with_priority(crate::Priority::default(), pid) } // rustdoc-stripper-ignore-next /// Create a `Future` that will resolve once the child process with the given pid exits /// /// The `Future` will resolve to the pid of the child process and the exit code. /// /// The `Future` must be spawned on an `Executor` backed by a `glib::MainContext`. pub fn child_watch_future_with_priority( priority: Priority, pid: crate::Pid, ) -> Pin + Send + 'static>> { Box::pin(SourceFuture::new(move |send| { let mut send = Some(send); crate::child_watch_source_new(pid, None, priority, move |pid, code| { let _ = send.take().unwrap().send((pid, code)); }) })) } #[cfg(any(unix, docsrs))] #[cfg_attr(docsrs, doc(cfg(unix)))] // rustdoc-stripper-ignore-next /// Create a `Future` that will resolve once the given UNIX signal is raised /// /// The `Future` must be spawned on an `Executor` backed by a `glib::MainContext`. pub fn unix_signal_future(signum: i32) -> Pin + Send + 'static>> { unix_signal_future_with_priority(crate::Priority::default(), signum) } #[cfg(any(unix, docsrs))] #[cfg_attr(docsrs, doc(cfg(unix)))] // rustdoc-stripper-ignore-next /// Create a `Future` that will resolve once the given UNIX signal is raised /// /// The `Future` must be spawned on an `Executor` backed by a `glib::MainContext`. pub fn unix_signal_future_with_priority( priority: Priority, signum: i32, ) -> Pin + Send + 'static>> { Box::pin(SourceFuture::new(move |send| { let mut send = Some(send); crate::unix_signal_source_new(signum, None, priority, move || { let _ = send.take().unwrap().send(()); ControlFlow::Break }) })) } // rustdoc-stripper-ignore-next /// Represents a `Stream` around a `glib::Source`. The stream will /// be provide all values that are provided by the source pub struct SourceStream { create_source: Option, source: Option<(Source, mpsc::UnboundedReceiver)>, } impl Unpin for SourceStream {} impl SourceStream where F: FnOnce(mpsc::UnboundedSender) -> Source + 'static, { // rustdoc-stripper-ignore-next /// Create a new `SourceStream` /// /// The provided closure should return a newly created `glib::Source` when called /// and pass the values provided by the source to the sender that is passed /// to the closure. pub fn new(create_source: F) -> SourceStream { SourceStream { create_source: Some(create_source), source: None, } } } impl Stream for SourceStream where F: FnOnce(mpsc::UnboundedSender) -> Source + 'static, { type Item = T; fn poll_next(mut self: pin::Pin<&mut Self>, ctx: &mut task::Context) -> Poll> { let SourceStream { ref mut create_source, ref mut source, .. } = *self; if let Some(create_source) = create_source.take() { let main_context = MainContext::ref_thread_default(); assert!( main_context.is_owner(), "Spawning futures only allowed if the thread is owning the MainContext" ); // Channel for sending back the Source result to our future here. // // In theory we could directly continue polling the // corresponding task from the Source callback, // however this would break at the very least // the g_main_current_source() API. let (send, recv) = mpsc::unbounded(); let s = create_source(send); s.attach(Some(&main_context)); *source = Some((s, recv)); } // At this point we must have a receiver let res = { let &mut (_, ref mut receiver) = source.as_mut().unwrap(); Pin::new(receiver).poll_next(ctx) }; #[allow(clippy::match_wild_err_arm)] match res { Poll::Ready(v) => { if v.is_none() { // Get rid of the reference to the source, it triggered let _ = source.take(); } Poll::Ready(v) } Poll::Pending => Poll::Pending, } } } impl FusedStream for SourceStream where F: FnOnce(mpsc::UnboundedSender) -> Source + 'static, { fn is_terminated(&self) -> bool { self.create_source.is_none() && self .source .as_ref() .map_or(true, |(_, receiver)| receiver.is_terminated()) } } impl Drop for SourceStream { fn drop(&mut self) { // Get rid of the source, we don't care anymore if it still triggers if let Some((source, _)) = self.source.take() { source.destroy(); } } } // rustdoc-stripper-ignore-next /// Create a `Stream` that will provide a value every given number of milliseconds. /// /// The `Future` must be spawned on an `Executor` backed by a `glib::MainContext`. pub fn interval_stream(value: Duration) -> Pin + Send + 'static>> { interval_stream_with_priority(crate::Priority::default(), value) } // rustdoc-stripper-ignore-next /// Create a `Stream` that will provide a value every given number of milliseconds. /// /// The `Future` must be spawned on an `Executor` backed by a `glib::MainContext`. pub fn interval_stream_with_priority( priority: Priority, value: Duration, ) -> Pin + Send + 'static>> { Box::pin(SourceStream::new(move |send| { crate::timeout_source_new(value, None, priority, move || { if send.unbounded_send(()).is_err() { ControlFlow::Break } else { ControlFlow::Continue } }) })) } // rustdoc-stripper-ignore-next /// Create a `Stream` that will provide a value every given number of seconds. /// /// The `Stream` must be spawned on an `Executor` backed by a `glib::MainContext`. pub fn interval_stream_seconds(value: u32) -> Pin + Send + 'static>> { interval_stream_seconds_with_priority(crate::Priority::default(), value) } // rustdoc-stripper-ignore-next /// Create a `Stream` that will provide a value every given number of seconds. /// /// The `Stream` must be spawned on an `Executor` backed by a `glib::MainContext`. pub fn interval_stream_seconds_with_priority( priority: Priority, value: u32, ) -> Pin + Send + 'static>> { Box::pin(SourceStream::new(move |send| { crate::timeout_source_new_seconds(value, None, priority, move || { if send.unbounded_send(()).is_err() { ControlFlow::Break } else { ControlFlow::Continue } }) })) } #[cfg(any(unix, docsrs))] #[cfg_attr(docsrs, doc(cfg(unix)))] // rustdoc-stripper-ignore-next /// Create a `Stream` that will provide a value whenever the given UNIX signal is raised /// /// The `Stream` must be spawned on an `Executor` backed by a `glib::MainContext`. pub fn unix_signal_stream(signum: i32) -> Pin + Send + 'static>> { unix_signal_stream_with_priority(crate::Priority::default(), signum) } #[cfg(any(unix, docsrs))] #[cfg_attr(docsrs, doc(cfg(unix)))] // rustdoc-stripper-ignore-next /// Create a `Stream` that will provide a value whenever the given UNIX signal is raised /// /// The `Stream` must be spawned on an `Executor` backed by a `glib::MainContext`. pub fn unix_signal_stream_with_priority( priority: Priority, signum: i32, ) -> Pin + Send + 'static>> { Box::pin(SourceStream::new(move |send| { crate::unix_signal_source_new(signum, None, priority, move || { if send.unbounded_send(()).is_err() { ControlFlow::Break } else { ControlFlow::Continue } }) })) } #[cfg(test)] mod tests { use std::{thread, time::Duration}; use futures_util::{future::FutureExt, stream::StreamExt}; use super::*; #[test] fn test_timeout() { let c = MainContext::new(); c.block_on(timeout_future(Duration::from_millis(20))); } #[test] fn test_timeout_send() { let c = MainContext::new(); let l = crate::MainLoop::new(Some(&c), false); let l_clone = l.clone(); c.spawn(timeout_future(Duration::from_millis(20)).then(move |()| { l_clone.quit(); futures_util::future::ready(()) })); l.run(); } #[test] fn test_interval() { let c = MainContext::new(); let mut count = 0; { let count = &mut count; c.block_on( interval_stream(Duration::from_millis(20)) .take(2) .for_each(|()| { *count += 1; futures_util::future::ready(()) }) .map(|_| ()), ); } assert_eq!(count, 2); } #[test] fn test_timeout_and_channel() { let c = MainContext::default(); let res = c.block_on(timeout_future(Duration::from_millis(20)).then(|()| { let (sender, receiver) = oneshot::channel(); thread::spawn(move || { sender.send(1).unwrap(); }); receiver.then(|i| futures_util::future::ready(i.unwrap())) })); assert_eq!(res, 1); } }