Add free function and rename in_context

futures-testing/src/task.rs

@@ -4,4 +4,4 @@ mod context;
 pub mod executor;
 pub mod wake;
 
-pub use self::context::TestContext;
+pub use self::context::{TestContext, with_context};

futures-testing/src/task/context.rs

@@ -26,14 +26,14 @@ use std::sync::Arc;
 ///     tx2.send(val).unwrap();
 /// });
 ///
-/// let res = context.in_context(|cx| future.as_pin_mut().poll(cx));
+/// let res = context.with(|cx| future.as_pin_mut().poll(cx));
 /// assert_eq!(res, Poll::Pending);
 ///
 /// assert_eq!(context.wake().count(), 0);
 /// tx1.send(5).unwrap();
 /// assert_eq!(context.wake().count(), 1);
 ///
-/// let res = context.in_context(|cx| future.as_pin_mut().poll(cx));
+/// let res = context.with(|cx| future.as_pin_mut().poll(cx));
 /// assert_eq!(res, Poll::Ready(()));
 ///
 /// assert_eq!(rx2.try_recv(), Ok(Some(5)));
@@ -73,7 +73,7 @@ where
 
     /// Call a method with a [`Context`] referring to this [`TestContext`]'s
     /// [`Wake`] and [`Executor`] implementations.
-    pub fn in_context<R, F>(&mut self, f: F) -> R
+    pub fn with<R, F>(&mut self, f: F) -> R
     where
         F: FnOnce(&mut Context) -> R,
     {
@@ -92,3 +92,34 @@ where
         Self::new(W::default(), E::default())
     }
 }
+
+/// Call a method with a [`Context`][futures_core::task::Context] using the
+/// specified [`Wake`][futures_core::task::Wake] and
+/// [`Executor`][futures_core::task::Executor] implementations.
+///
+/// # Examples
+///
+/// ```
+/// #![feature(async_await, await_macro, futures_api, pin)]
+///
+/// use futures::{future::Future, task::Poll};
+/// use futures_testing::task::{self, wake, executor};
+/// use std::boxed::PinBox;
+///
+/// let mut future = PinBox::new(async {
+///     5
+/// });
+///
+/// let res = task::with_context::<wake::Panic, executor::Panic, _, _>(|cx| {
+///     future.as_pin_mut().poll(cx)
+/// });
+/// assert_eq!(res, Poll::Ready(5));
+/// ```
+pub fn with_context<W, E, R, F>(f: F) -> R
+where
+    W: Wake + Default + 'static,
+    E: Executor + Default + 'static,
+    F: FnOnce(&mut Context) -> R,
+{
+    TestContext::<W, E>::default().with(f)
+}

futures-testing/src/task/executor/panic.rs

@@ -16,7 +16,7 @@ use futures_core::{
 ///
 /// let mut context = TestContext::<wake::Panic, executor::Panic>::default();
 ///
-/// context.in_context(|cx| {
+/// context.with(|cx| {
 ///     cx.executor().spawn(async { });
 /// });
 /// ```

futures-testing/src/task/executor/record.rs

@@ -16,7 +16,7 @@ use futures_core::{
 ///
 /// let mut context = TestContext::<wake::Panic, executor::Record>::default();
 ///
-/// context.in_context(|cx| {
+/// context.with(|cx| {
 ///     cx.executor().spawn(async { });
 /// });
 ///

futures-testing/src/task/wake/counter.rs

@@ -19,7 +19,7 @@ use std::sync::{
 /// assert_eq!(context.wake().count(), 0);
 ///
 /// let mut waker = None;
-/// context.in_context(|cx| {
+/// context.with(|cx| {
 ///     cx.waker().wake();
 ///     waker = Some(cx.waker().clone());
 /// });

futures-testing/src/task/wake/noop.rs

@@ -13,7 +13,7 @@ use std::sync::Arc;
 ///
 /// let mut context = TestContext::<wake::Noop, executor::Panic>::default();
 ///
-/// context.in_context(|cx| {
+/// context.with(|cx| {
 ///     cx.waker().wake();
 /// });
 /// ```

futures-testing/src/task/wake/panic.rs

@@ -12,7 +12,7 @@ use std::sync::Arc;
 ///
 /// let mut context = TestContext::<wake::Panic, executor::Panic>::default();
 ///
-/// context.in_context(|cx| {
+/// context.with(|cx| {
 ///     cx.waker().wake();
 /// });
 /// ```