Commit f53fcbb

committed

test,docs: Add stream::pending example code

1 parent e9357c0 commit f53fcbbCopy full SHA for f53fcbb

File tree

+21

-0

lines changed

+21

-0

lines changed

Lines changed: 21 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,27 @@ pub struct Pending<T> {`
`18`	`18`	`/// Creates a stream that never returns any items.`
`19`	`19`	`///`
`20`	`20`	/// The returned stream will always return `Pending` when polled.
	`21`	`+/// # Examples`
	`22`	`+///`
	`23`	+/// ```
	`24`	`+/// # async_std::task::block_on(async {`
	`25`	`+/// #`
	`26`	`+/// use std::time::Duration;`
	`27`	`+///`
	`28`	`+/// use async_std::prelude::*;`
	`29`	`+/// use async_std::stream;`
	`30`	`+///`
	`31`	`+/// let dur = Duration::from_millis(100);`
	`32`	`+/// let mut s = stream::pending::<()>().timeout(dur);`
	`33`	`+///`
	`34`	`+/// let item = s.next().await;`
	`35`	`+///`
	`36`	`+/// assert!(item.is_some());`
	`37`	`+/// assert!(item.unwrap().is_err());`
	`38`	`+///`
	`39`	`+/// #`
	`40`	`+/// # })`
	`41`	+/// ```
`21`	`42`	`pub fn pending<T>() -> Pending<T> {`
`22`	`43`	`Pending {`
`23`	`44`	`_marker: PhantomData,`

Comments

(0)