Skip to content

Commit 58662f6

Browse files
lauraltjiangliu
authored andcommitted
add missing documentation to VolatileRef::as_ptr
VolatileRef::as_ptr was not properly documented regarding the dirty page tracking support. Signed-off-by: Laura Loghin <[email protected]>
1 parent fdde64a commit 58662f6

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/volatile_memory.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -952,7 +952,9 @@ where
952952
}
953953
}
954954

955-
/// Returns a pointer to the underlying memory.
955+
/// Returns a pointer to the underlying memory. Mutable accesses performed
956+
/// using the resulting pointer are not automatically accounted for by the dirty bitmap
957+
/// tracking functionality.
956958
pub fn as_ptr(&self) -> *mut u8 {
957959
self.addr as *mut u8
958960
}

0 commit comments

Comments
 (0)