Explain the bits of UndefMask

rust-lang · Mar 12, 2019 · 1ae1312 · 1ae1312
1 parent 60fde17
commit 1ae1312
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/librustc/mir/interpret/allocation.rs b/src/librustc/mir/interpret/allocation.rs
@@ -613,6 +613,8 @@ impl<Tag> DerefMut for Relocations<Tag> {
 
 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>,