[−][src]Struct async_fuse::Stack
Fusing adapter for fusing a value on the stack.
Note that this is used for values which should be pinned as they are being polled.
See Stack::new for details.
Implementations
impl<T> Stack<T>
[src]
pub fn new(value: T) -> Self
[src]
Construct a fusing adapter that is capable of polling an interior future.
Stack the future completes, the adapter will switch to an empty state and return Poll::Pending until [set][Stack::set] again.
Examples
use std::time::Duration; use tokio::time; let mut sleep = async_fuse::Stack::new(time::sleep(Duration::from_millis(200))); tokio::pin!(sleep); tokio::select! { _ = &mut sleep => { assert!(sleep.is_empty()); sleep.set(async_fuse::Stack::new(time::sleep(Duration::from_millis(200)))); } } assert!(!sleep.is_empty());
pub fn empty() -> Self
[src]
Construct an empty fuse.
Examples
use tokio::time; let mut sleep = async_fuse::Stack::<time::Sleep>::empty(); tokio::pin!(sleep); assert!(sleep.is_empty());
pub fn is_empty(&self) -> bool
[src]
Test if the polled for value is empty.
Examples
use tokio::time; use std::time::Duration; let mut sleep = async_fuse::Stack::new(time::sleep(Duration::from_millis(200))); tokio::pin!(sleep); assert!(!sleep.is_empty()); sleep.set(async_fuse::Stack::empty()); assert!(sleep.is_empty());
pub fn as_inner_ref(&self) -> Option<&T>
[src]
Access the interior value as a reference.
Examples
use tokio::time; use std::time::Duration; let mut sleep = async_fuse::Stack::new(time::sleep(Duration::from_millis(200))); tokio::pin!(sleep); assert!(sleep.as_inner_ref().is_some()); sleep.set(async_fuse::Stack::empty()); assert!(sleep.as_inner_ref().is_none());
pub fn as_inner_mut(&mut self) -> Option<&mut T> where
Self: Unpin,
[src]
Self: Unpin,
Convert into its inner mutable value.
pub fn as_pin_mut(&mut self) -> Pin<&mut Self> where
Self: Unpin,
[src]
Self: Unpin,
Helper conversion to a pinned value.
Examples
use tokio::sync::mpsc; let (tx, rx) = mpsc::unbounded_channel::<u32>(); let mut rx = async_fuse::Stack::new(rx); tx.send(42); // Manually poll the sleep. assert_eq!(rx.as_pin_mut().poll_stream(|mut i, cx| i.poll_recv(cx)).await, Some(42)); rx = async_fuse::Stack::empty(); assert!(rx.is_empty());
pub async fn poll_inner<P, O>(self: Pin<&mut Self>, poll: P) -> O where
P: FnMut(Pin<&mut T>, &mut Context<'_>) -> Poll<O>,
[src]
P: FnMut(Pin<&mut T>, &mut Context<'_>) -> Poll<O>,
Poll the current value with the given polling implementation.
This can be used for types which only provides a polling function.
This will never empty the underlying value.
Examples
use tokio::sync::mpsc; use std::future::Future; async fn op(n: u32) -> u32 { n } let op1 = async_fuse::Stack::new(op(1)); tokio::pin!(op1); assert_eq!(op1.as_mut().poll_inner(|mut i, cx| i.poll(cx)).await, 1); assert!(!op1.is_empty()); op1.set(async_fuse::Stack::new(op(2))); assert_eq!(op1.as_mut().poll_inner(|mut i, cx| i.poll(cx)).await, 2); assert!(!op1.is_empty());
pub async fn poll_future<P, O>(self: Pin<&mut Self>, poll: P) -> O where
P: FnMut(Pin<&mut T>, &mut Context<'_>) -> Poll<O>,
[src]
P: FnMut(Pin<&mut T>, &mut Context<'_>) -> Poll<O>,
Poll the current value with the given polling implementation.
This can be used for types which only provides a polling function.
Once the underlying poll impl returns Poll::Ready
, the underlying
value will be emptied.
Examples
use tokio::sync::mpsc; use std::future::Future; async fn op(n: u32) -> u32 { n } let op1 = async_fuse::Stack::new(op(1)); tokio::pin!(op1); assert_eq!(op1.as_mut().poll_future(|mut i, cx| i.poll(cx)).await, 1); assert!(op1.is_empty()); op1.set(async_fuse::Stack::new(op(2))); assert!(!op1.is_empty()); assert_eq!(op1.as_mut().poll_future(|mut i, cx| i.poll(cx)).await, 2); assert!(op1.is_empty());
pub async fn poll_stream<P, O>(self: Pin<&mut Self>, poll: P) -> Option<O> where
P: FnMut(Pin<&mut T>, &mut Context<'_>) -> Poll<Option<O>>,
[src]
P: FnMut(Pin<&mut T>, &mut Context<'_>) -> Poll<Option<O>>,
Poll the current value with the given polling implementation.
This can be used for types which only provides a polling function, or types which can be polled multiple streams. Like streams which do not provide a Stream implementation.
Will empty the fused value once the underlying poll returns
Poll::Ready(None)
.
Examples
use tokio::sync::mpsc; use std::future::Future; use futures_core::Stream; fn op(n: u32) -> impl Stream<Item = u32> { async_stream::stream! { yield n; yield n + 1; } } let op1 = async_fuse::Stack::new(op(1)); tokio::pin!(op1); assert!(!op1.is_empty()); assert_eq!(op1.as_mut().poll_stream(|mut i, cx| i.poll_next(cx)).await, Some(1)); assert_eq!(op1.as_mut().poll_stream(|mut i, cx| i.poll_next(cx)).await, Some(2)); assert!(!op1.is_empty()); assert_eq!(op1.as_mut().poll_stream(|mut i, cx| i.poll_next(cx)).await, None); assert!(op1.is_empty());
pub async fn next(&mut self) -> Option<T::Item> where
T: Stream,
Self: Unpin,
[src]
T: Stream,
Self: Unpin,
Poll the next value in the stream where the underlying value is unpin.
Behaves the same as [poll_stream], except that it only works for values which are Unpin.
Examples
use tokio::sync::mpsc; use std::future::Future; use futures_core::Stream; fn op(n: u32) -> impl Stream<Item = u32> { async_stream::stream! { yield n; yield n + 1; } } let mut stream = async_fuse::Stack::new(Box::pin(op(1))); assert!(!stream.is_empty()); assert_eq!(stream.next().await, Some(1)); assert_eq!(stream.next().await, Some(2)); assert_eq!(stream.next().await, None); assert!(stream.is_empty());
Trait Implementations
impl<T> Default for Stack<T>
[src]
impl<T> From<Option<T>> for Stack<T>
[src]
impl<T> Future for Stack<T> where
T: Future,
[src]
T: Future,
type Output = T::Output
The type of value produced on completion.
pub fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>
[src]
impl<T> Stream for Stack<T> where
T: Stream,
[src]
T: Stream,
type Item = T::Item
Values yielded by the stream.
pub fn poll_next(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>
pub fn size_hint(&self) -> (usize, Option<usize>)
[src]
impl<'__pin, T> Unpin for Stack<T> where
__Origin<'__pin, T>: Unpin,
[src]
__Origin<'__pin, T>: Unpin,
Auto Trait Implementations
impl<T> RefUnwindSafe for Stack<T> where
T: RefUnwindSafe,
[src]
T: RefUnwindSafe,
impl<T> Send for Stack<T> where
T: Send,
[src]
T: Send,
impl<T> Sync for Stack<T> where
T: Sync,
[src]
T: Sync,
impl<T> UnwindSafe for Stack<T> where
T: UnwindSafe,
[src]
T: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<F> IntoFuture for F where
F: Future,
[src]
F: Future,
type Output = <F as Future>::Output
into_future
)The output that the future will produce on completion.
type Future = F
into_future
)Which kind of future are we turning this into?
pub fn into_future(self) -> <F as IntoFuture>::Future
[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.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<F, T, E> TryFuture for F where
F: Future<Output = Result<T, E>> + ?Sized,
[src]
F: Future<Output = Result<T, E>> + ?Sized,
type Ok = T
The type of successful values yielded by this future
type Error = E
The type of failures yielded by this future
pub fn try_poll(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>
[src]
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>
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.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<S, T, E> TryStream for S where
S: Stream<Item = Result<T, E>> + ?Sized,
[src]
S: Stream<Item = Result<T, E>> + ?Sized,