Skip to content

Commit e05f1c1

Browse files
Rollup merge of #42372 - frewsxcv:frewsxcv/improve-receiver-docs, r=QuietMisdreavus
Rewrite a couple `Receiver` doc examples. None
2 parents 1a3d026 + eb48ee7 commit e05f1c1

File tree

1 file changed

+21
-14
lines changed

1 file changed

+21
-14
lines changed

src/libstd/sync/mpsc/mod.rs

+21-14
Original file line numberDiff line numberDiff line change
@@ -1370,14 +1370,16 @@ impl<T> Receiver<T> {
13701370
/// let (send, recv) = channel();
13711371
///
13721372
/// thread::spawn(move || {
1373-
/// send.send(1u8).unwrap();
1374-
/// send.send(2u8).unwrap();
1375-
/// send.send(3u8).unwrap();
1373+
/// send.send(1).unwrap();
1374+
/// send.send(2).unwrap();
1375+
/// send.send(3).unwrap();
13761376
/// });
13771377
///
1378-
/// for x in recv.iter() {
1379-
/// println!("Got: {}", x);
1380-
/// }
1378+
/// let mut iter = recv.iter();
1379+
/// assert_eq!(iter.next(), Some(1));
1380+
/// assert_eq!(iter.next(), Some(2));
1381+
/// assert_eq!(iter.next(), Some(3));
1382+
/// assert_eq!(iter.next(), None);
13811383
/// ```
13821384
#[stable(feature = "rust1", since = "1.0.0")]
13831385
pub fn iter(&self) -> Iter<T> {
@@ -1393,29 +1395,34 @@ impl<T> Receiver<T> {
13931395
///
13941396
/// # Examples
13951397
///
1396-
/// ```rust
1398+
/// ```no_run
13971399
/// use std::sync::mpsc::channel;
13981400
/// use std::thread;
13991401
/// use std::time::Duration;
14001402
///
14011403
/// let (sender, receiver) = channel();
14021404
///
1403-
/// // Nothing is in the buffer yet
1405+
/// // nothing is in the buffer yet
14041406
/// assert!(receiver.try_iter().next().is_none());
1405-
/// println!("Nothing in the buffer...");
14061407
///
14071408
/// thread::spawn(move || {
1409+
/// thread::sleep(Duration::from_secs(1));
14081410
/// sender.send(1).unwrap();
14091411
/// sender.send(2).unwrap();
14101412
/// sender.send(3).unwrap();
14111413
/// });
14121414
///
1413-
/// println!("Going to sleep...");
1414-
/// thread::sleep(Duration::from_secs(2)); // block for two seconds
1415+
/// // nothing is in the buffer yet
1416+
/// assert!(receiver.try_iter().next().is_none());
1417+
///
1418+
/// // block for two seconds
1419+
/// thread::sleep(Duration::from_secs(2));
14151420
///
1416-
/// for x in receiver.try_iter() {
1417-
/// println!("Got: {}", x);
1418-
/// }
1421+
/// let mut iter = receiver.try_iter();
1422+
/// assert_eq!(iter.next(), Some(1));
1423+
/// assert_eq!(iter.next(), Some(2));
1424+
/// assert_eq!(iter.next(), Some(3));
1425+
/// assert_eq!(iter.next(), None);
14191426
/// ```
14201427
#[stable(feature = "receiver_try_iter", since = "1.15.0")]
14211428
pub fn try_iter(&self) -> TryIter<T> {

0 commit comments

Comments
 (0)