[][src]Function pre::core::mut_pointer__impl__read_unaligned__

pub fn mut_pointer__impl__read_unaligned__()

A stub for the preconditions of the core::mut_pointer<T>::read_unaligned function.

What is this function?

This function was generated by an impl block inside a extern_crate attribute that looked like this:

This example is not tested
impl< T > mut_pointer < T > where T : ? Sized {
    unsafe fn read_unaligned(self) -> T;
    /* other items omitted */
}

Preconditions on external functions inside of an impl block are attached to empty functions like this one. When the preconditions should be checked, a call to this function is inserted, which triggers checking the preconditions.

This function has preconditions

This function has the following preconditions generated by pre attributes:

  • the pointer self must be valid for reads
  • self points to a properly initialized value of type T
  • T is Copy or the value at *self isn't used after this call

To call the function you need to assure that the preconditions hold:

This example is not tested
#[forward(impl pre::core::mut_pointer)]
#[assure(
    valid_ptr(self, r),
    reason = "<specify the reason why you can assure this here>"
)]
#[assure(
    "`self` points to a properly initialized value of type `T`",
    reason = "<specify the reason why you can assure this here>"
)]
#[assure(
    "`T` is `Copy` or the value at `*self` isn\'t used after this call",
    reason = "<specify the reason why you can assure this here>"
)]
x.read_unaligned(/* parameters omitted */);