[−][src]Function pre::core::mut_pointer__impl__offset__
pub fn mut_pointer__impl__offset__()
A stub for the preconditions of the core::mut_pointer<T>::offset
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 offset(self, count : isize) -> * const 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 starting and the resulting pointer are in bounds of the same allocated object
- the computed offset, in bytes, does not overflow an
isize
- performing the offset does not result in overflow
To call the function you need to assure
that the preconditions hold:
ⓘThis example is not tested
#[forward(impl pre::core::mut_pointer)] #[assure( "the starting and the resulting pointer are in bounds of the same allocated object", reason = "<specify the reason why you can assure this here>" )] #[assure( "the computed offset, in bytes, does not overflow an `isize`", reason = "<specify the reason why you can assure this here>" )] #[assure( "performing the offset does not result in overflow", reason = "<specify the reason why you can assure this here>" )] x.offset(/* parameters omitted */);