Function std::ptr::read_volatile 1.9.0
[−]
[src]
pub unsafe fn read_volatile<T>(src: *const T) -> T
Performs a volatile read of the value from src
without moving it. This
leaves the memory in src
unchanged.
Volatile operations are intended to act on I/O memory, and are guaranteed to not be elided or reordered by the compiler across other volatile operations.
Notes
Rust does not currently have a rigorously and formally defined memory model, so the precise semantics of what "volatile" means here is subject to change over time. That being said, the semantics will almost always end up pretty similar to C11's definition of volatile.
Safety
Beyond accepting a raw pointer, this is unsafe because it semantically
moves the value out of src
without preventing further usage of src
.
If T
is not Copy
, then care must be taken to ensure that the value at
src
is not used before the data is overwritten again (e.g. with write
,
zero_memory
, or copy_memory
). Note that *src = foo
counts as a use
because it will attempt to drop the value previously at *src
.
Examples
Basic usage:
let x = 12; let y = &x as *const i32; unsafe { assert_eq!(std::ptr::read_volatile(y), 12); }