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

# 1.0.0[−][src]Module std::ptr

Raw, unsafe pointers, `*const T`, and `*mut T`.

See also the pointer primitive types.

## Structs

NonNull | `*mut T` but non-zero and covariant.

## Functions

copy⚠ | Copies `count * size_of<T>` bytes from `src` to `dst`. The source and destination may overlap.
copy_nonoverlapping⚠ | Copies `count * size_of<T>` bytes from `src` to `dst`. The source and destination may not overlap.
drop_in_place⚠ | Executes the destructor (if any) of the pointed-to value.
eq | Compare raw pointers for equality.
null | Creates a null raw pointer.
null_mut | Creates a null mutable raw pointer.
read⚠ | Reads the value from `src` without moving it. This leaves the memory in `src` unchanged.
read_unaligned⚠ | Reads the value from `src` without moving it. This leaves the memory in `src` unchanged.
read_volatile⚠ | Performs a volatile read of the value from `src` without moving it. This leaves the memory in `src` unchanged.
replace⚠ | Moves `src` into the pointed `dest`, returning the previous `dest` value.
swap⚠ | Swaps the values at two mutable locations of the same type, without deinitializing either.
swap_nonoverlapping⚠ | Swaps a sequence of values at two mutable locations of the same type.
write⚠ | Overwrites a memory location with the given value without reading or dropping the old value.
write_bytes⚠ | Invokes memset on the specified pointer, setting `count * size_of::<T>()` bytes of memory starting at `dst` to `val`.
write_unaligned⚠ | Overwrites a memory location with the given value without reading or dropping the old value.
write_volatile⚠ | Performs a volatile write of a memory location with the given value without reading or dropping the old value.

# 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
`+`
  Expand all sections
`-`
  Collapse 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`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)