summary refs log tree commit diff
path: root/src/libstd/primitive_docs.rs
diff options
context:
space:
mode:
authorGuillaume Gomez <guillaume1.gomez@gmail.com>2017-01-20 22:32:12 +0100
committerGuillaume Gomez <guillaume1.gomez@gmail.com>2017-01-21 12:35:43 +0100
commitb09305edb98fcd835abd116327851c65129c24e9 (patch)
tree24f1d6a32edc36d47d788f08afb0c0338a6f78af /src/libstd/primitive_docs.rs
parentc8af93f0901c336e873ce18274026d0fd9bc7c1f (diff)
downloadrust-b09305edb98fcd835abd116327851c65129c24e9.tar.gz
rust-b09305edb98fcd835abd116327851c65129c24e9.zip
Specify the result of integer cast on boolean
Diffstat (limited to 'src/libstd/primitive_docs.rs')
-rw-r--r--src/libstd/primitive_docs.rs10
1 files changed, 9 insertions, 1 deletions
diff --git a/src/libstd/primitive_docs.rs b/src/libstd/primitive_docs.rs
index a9aa2dc2671..ce6ea2c1257 100644
--- a/src/libstd/primitive_docs.rs
+++ b/src/libstd/primitive_docs.rs
@@ -12,7 +12,8 @@
 //
 /// The boolean type.
 ///
-/// The `bool` represents a value, which could only be either `true` or `false`.
+/// The `bool` represents a value, which could only be either `true` or `false`. If you cast
+/// a `bool` into an integer, `true` will be 1 and `false` will be 0.
 ///
 /// # Basic usage
 ///
@@ -56,6 +57,13 @@
 ///
 /// Also, since `bool` implements the [`Copy`](marker/trait.Copy.html) trait, we don't
 /// have to worry about the move semantics (just like the integer and float primitives).
+///
+/// Now an example of `bool` cast to integer type:
+///
+/// ```
+/// assert_eq!(true as i32, 1);
+/// assert_eq!(false as i32, 0);
+/// ```
 #[stable(feature = "rust1", since = "1.0.0")]
 mod prim_bool { }