std::ptr::read_volatile - Rust
Description: API documentation for the Rust `read_volatile` fn in crate `std`.
Keywords: rust, rustlang, rust-lang, read_volatile

# 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.

The compiler shouldn't change the relative order or number of volatile memory operations. However, volatile memory operations on zero-sized types (e.g. if a zero-sized type is passed to `read_volatile`) are no-ops and may be ignored.

# 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`, `write_bytes`, or `copy`). 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);
    }Run

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
↑
  Move up in search results
↓
  Move down in search results
↹
  Switch tab
⏎
  Go to active search result
+ / -
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)