core::slice::from_raw_parts - Rust
Description: API documentation for the Rust `from_raw_parts` fn in crate `core`.
Keywords: rust, rustlang, rust-lang, from_raw_parts

# 1.0.0[−][src]Function core::slice::from_raw_parts

    pub unsafe fn from_raw_parts<'a, T>(data: *const T, len: usize) -> &'a [T]

Forms a slice from a pointer and a length.

The `len` argument is the number of elements, not the number of bytes.

# Safety

Behavior is undefined if any of the following conditions are violated:

- `data` must be valid for reads for `len * mem::size_of::<T>()` many bytes, and it must be properly aligned. This means in particular:

  - The entire memory range of this slice must be contained within a single allocated object! Slices can never span across multiple allocated objects.
  - `data` must be non-null and aligned even for zero-length slices. One reason for this is that enum layout optimizations may rely on references (including slices of any length) being aligned and non-null to distinguish them from other data. You can obtain a pointer that is usable as `data` for zero-length slices using `NonNull::dangling()`.

- The memory referenced by the returned slice must not be mutated for the duration of lifetime `'a`, except inside an `UnsafeCell`.

- The total size `len * mem::size_of::<T>()` of the slice must be no larger than `isize::MAX`. See the safety documentation of `pointer::offset`.

# Caveat

The lifetime for the returned slice is inferred from its usage. To prevent accidental misuse, it's suggested to tie the lifetime to whichever source lifetime is safe in the context, such as by providing a helper function taking the lifetime of a host value for the slice, or by explicit annotation.

# Examples

    use std::slice;

    // manifest a slice for a single element
    let x = 42;
    let ptr = &x as *const _;
    let slice = unsafe { slice::from_raw_parts(ptr, 1) };
    assert_eq!(slice[0], 42);

Run