[][src]Function pre::std::mut_pointer__impl__write_bytes__

pub fn mut_pointer__impl__write_bytes__()

A stub for the preconditions of the std::mut_pointer<T>::write_bytes 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_bytes(self, val : u8, count : usize);
    /* 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
  • self is valid for count * size_of::<T>() bytes
  • the pointer self must have a proper alignment for its type
  • a valid value of T is written to *self or *self is never used

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

This example is not tested
#[forward(impl pre::std::mut_pointer)]
#[assure(
    valid_ptr(self, w),
    reason = "<specify the reason why you can assure this here>"
)]
#[assure(
    "`self` is valid for `count * size_of::<T>()` bytes",
    reason = "<specify the reason why you can assure this here>"
)]
#[assure(
    proper_align(self),
    reason = "<specify the reason why you can assure this here>"
)]
#[assure(
    "a valid value of `T` is written to `*self` or `*self` is never used",
    reason = "<specify the reason why you can assure this here>"
)]
x.write_bytes(/* parameters omitted */);