[][src]Function pre::core::mut_pointer__impl__write_volatile__

pub fn mut_pointer__impl__write_volatile__()

A stub for the preconditions of the core::mut_pointer<T>::write_volatile 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 write_volatile(self, val : 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 writes
  • the pointer self must have a proper alignment for its type

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, w),
    reason = "<specify the reason why you can assure this here>"
)]
#[assure(
    proper_align(self),
    reason = "<specify the reason why you can assure this here>"
)]
x.write_volatile(/* parameters omitted */);