Explain the bits of `UndefMask`

diff --git a/src/librustc/mir/interpret/allocation.rs b/src/librustc/mir/interpret/allocation.rs
index 004804f7c211e043aec3588876d390bed6b6fec0..2ce9a4a0f204dbde5b7db7eb954877fd50d739ea 100644 (file)
--- a/src/librustc/mir/interpret/allocation.rs
+++ b/src/librustc/mir/interpret/allocation.rs
@@ -613,6 +613,8 @@ fn deref_mut(&mut self) -> &mut Self::Target {
 
 type Block = u64;
 
+/// A bitmask where each bit refers to the byte with the same index. If the bit is `true`, the byte
+/// is defined. If it is `false` the byte is undefined.
 #[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord, Hash, RustcEncodable, RustcDecodable)]
 pub struct UndefMask {
     blocks: Vec<Block>,