From dc3a39d807512c626495c16680df2fffc16e8722 Mon Sep 17 00:00:00 2001 From: Steve Klabnik Date: Mon, 1 Feb 2016 18:49:47 -0500 Subject: [PATCH] Explain behavior of _ Fixes #31154 --- src/doc/book/patterns.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/src/doc/book/patterns.md b/src/doc/book/patterns.md index 8e9e7246e56f..39a9cb1885e8 100644 --- a/src/doc/book/patterns.md +++ b/src/doc/book/patterns.md @@ -173,7 +173,31 @@ let (x, _, z) = coordinate(); Here, we bind the first and last element of the tuple to `x` and `z`, but ignore the middle element. -Similarly, you can use `..` in a pattern to disregard multiple values. +It’s worth noting that using `_` never binds the value in the first place, +which means a value may not move: + +```rust +let tuple: (u32, String) = (5, String::from("five")); + +// Here, tuple is moved, because the String moved: +let (x, _s) = tuple; + +// The next line would give "error: use of partially moved value: `tuple`" +// println!("Tuple is: {:?}", tuple); + +// However, + +let tuple = (5, String::from("five")); + +// Here, tuple is _not_ moved, as the String was never moved, and u32 is Copy: +let (x, _) = tuple; + +// That means this works: +println!("Tuple is: {:?}", tuple); +``` + +In a similar fashion to `_`, you can use `..` in a pattern to disregard +multiple values: ```rust enum OptionalTuple {