mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs for swap_nonoverlapping

Browse Source 
They closely mirror the docs for `copy_nonoverlapping`
This commit is contained in:
Dylan MacKenzie 2018-05-28 17:41:19 -07:00 committed by Ralf Jung
parent 04a08c60a1
commit 7b2ef6bd77
1 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/libcore/ptr.rs
View File

@ -226,12 +226,28 @@ pub unsafe fn swap<T>(x: *mut T, y: *mut T) {
mem::forget(tmp);
}
/// Swaps a sequence of values at two mutable locations of the same type.
/// Swaps `count * size_of::<T>()` bytes between the two regions of memory
/// beginning at `x` and `y`. The two regions must *not* overlap.
///
/// # Safety
///
/// The two arguments must each point to the beginning of `count` locations
/// of valid memory, and the two memory ranges must not overlap.
/// Behavior is undefined if any of the following conditions are violated:
///
/// * Both `x` and `y` must be [valid].
///
/// * Both `x` and `y` must be properly aligned.
///
/// * `x.offset(count)` must be [valid]. In other words, the region of memory
/// which begins at `x` and has a length of `count * size_of::<T>()` bytes
/// must belong to a single, live allocation.
///
/// * `y.offset(count)` must be [valid]. In other words, the region of memory
/// which begins at `y` and has a length of `count * size_of::<T>()` bytes
/// must belong to a single, live allocation.
///
/// * The two regions of memory must *not* overlap.
///
/// [valid]: ../ptr/index.html#safety
///
/// # Examples
///