Unsafe pointer utility functions
RawPtr
of RawPtr<T> for *T where <T>
- Extension methods for immutable pointersof RawPtr<T> for *mut T where <T>
- Extension methods for mutable pointersof Eq for *const T where <T>
of Ord for *const T where <T>
array_each
array_each_with_len
buf_len
- Return the offset of the first null pointer in buf
.const_offset
- Calculate the offset from a const pointercopy_memory
- Copies data from one location to another.copy_nonoverlapping_memory
- Copies data from one location to another.is_not_null
- Returns true if the pointer is not equal to the null pointer.is_null
- Returns true if the pointer is equal to the null pointer.mut_null
- Create an unsafe mutable null pointermut_offset
- Calculate the offset from a mut pointernull
- Create an unsafe null pointeroffset
- Calculate the offset from a pointerposition
- Return the first offset i
such that f(buf[i]) == true
.replace_ptr
set_memory
- Invokes memset on the specified pointer, setting count * size_of::<T>()
bytes of memory starting at dst
to c
.swap_ptr
- Swap the values at two mutable locations of the same type, without deinitialising or copying either one.to_const_unsafe_ptr
- Transform a const region pointer - &const T - to a const unsafe pointer - *const T.to_mut_unsafe_ptr
- Transform a mutable region pointer - &mut T - to a mutable unsafe pointer - *mut T.to_unsafe_ptr
- Transform a region pointer - &T - to an unsafe pointer - *T.RawPtr
is_null
fn is_null(&self) -> bool
is_not_null
fn is_not_null(&self) -> bool
to_option
unsafe fn to_option(&self) -> Option<&T>
offset
fn offset(&self, count: uint) -> Self
RawPtr<T>
for *T
where <T>
Extension methods for immutable pointers
is_null
fn is_null(&self) -> bool
Returns true if the pointer is equal to the null pointer.
is_not_null
fn is_not_null(&self) -> bool
Returns true if the pointer is not equal to the null pointer.
to_option
unsafe fn to_option(&self) -> Option<&T>
Returns None
if the pointer is null, or else returns the value wrapped in Some
.
While this method is useful for null-safety, it is important to note that this is still an unsafe operation because the returned value could be pointing to invalid memory.
offset
fn offset(&self, count: uint) -> *T
Calculates the offset from a pointer.
RawPtr<T>
for *mut T
where <T>
Extension methods for mutable pointers
is_null
fn is_null(&self) -> bool
Returns true if the pointer is equal to the null pointer.
is_not_null
fn is_not_null(&self) -> bool
Returns true if the pointer is not equal to the null pointer.
to_option
unsafe fn to_option(&self) -> Option<&T>
Returns None
if the pointer is null, or else returns the value wrapped in Some
.
While this method is useful for null-safety, it is important to note that this is still an unsafe operation because the returned value could be pointing to invalid memory.
offset
fn offset(&self, count: uint) -> *mut T
Calculates the offset from a mutable pointer.
Eq
for *const T
where <T>
eq
fn eq(&self, other: &*const T) -> bool
ne
fn ne(&self, other: &*const T) -> bool
Ord
for *const T
where <T>
lt
fn lt(&self, other: &*const T) -> bool
le
fn le(&self, other: &*const T) -> bool
ge
fn ge(&self, other: &*const T) -> bool
gt
fn gt(&self, other: &*const T) -> bool
array_each
unsafe fn array_each<T>(arr: **T, cb: &fn(*T))
Given a null-pointer-terminated **T (pointer to an array of pointers), iterate through each *T, passing to the provided callback function
SAFETY NOTE: This will only work with a null-terminated pointer array. Barely less-dodgey Pointer Arithmetic. Dragons be here.
array_each_with_len
unsafe fn array_each_with_len<T>(arr: **T, len: uint, cb: &fn(*T))
Given a **T (pointer to an array of pointers), iterate through each *T, up to the provided len
, passing to the provided callback function
SAFETY NOTE: Pointer-arithmetic. Dragons be here.
buf_len
unsafe fn buf_len<T>(buf: **T) -> uint
Return the offset of the first null pointer in buf
.
const_offset
fn const_offset<T>(ptr: *const T, count: uint) -> *const T
Calculate the offset from a const pointer
copy_memory
unsafe fn copy_memory<T>(dst: *mut T, src: *const T, count: uint)
Copies data from one location to another.
Copies count
elements (not bytes) from src
to dst
. The source and destination may overlap.
copy_nonoverlapping_memory
unsafe fn copy_nonoverlapping_memory<T>(dst: *mut T, src: *const T,
count: uint)
Copies data from one location to another.
Copies count
elements (not bytes) from src
to dst
. The source and destination may not overlap.
is_not_null
fn is_not_null<T>(ptr: *const T) -> bool
Returns true if the pointer is not equal to the null pointer.
is_null
fn is_null<T>(ptr: *const T) -> bool
Returns true if the pointer is equal to the null pointer.
mut_null
fn mut_null<T>() -> *mut T
Create an unsafe mutable null pointer
mut_offset
fn mut_offset<T>(ptr: *mut T, count: uint) -> *mut T
Calculate the offset from a mut pointer
null
fn null<T>() -> *T
Create an unsafe null pointer
offset
fn offset<T>(ptr: *T, count: uint) -> *T
Calculate the offset from a pointer
position
unsafe fn position<T>(buf: *T, f: &fn(&T) -> bool) -> uint
Return the first offset i
such that f(buf[i]) == true
.
replace_ptr
unsafe fn replace_ptr<T>(dest: *mut T, mut src: T) -> T
Replace the value at a mutable location with a new one, returning the old value, without deinitialising or copying either one.
set_memory
unsafe fn set_memory<T>(dst: *mut T, c: u8, count: uint)
Invokes memset on the specified pointer, setting count * size_of::<T>()
bytes of memory starting at dst
to c
.
swap_ptr
unsafe fn swap_ptr<T>(x: *mut T, y: *mut T)
Swap the values at two mutable locations of the same type, without deinitialising or copying either one.
to_const_unsafe_ptr
fn to_const_unsafe_ptr<T>(thing: &const T) -> *const T
Transform a const region pointer - &const T - to a const unsafe pointer - *const T.
to_mut_unsafe_ptr
fn to_mut_unsafe_ptr<T>(thing: &mut T) -> *mut T
Transform a mutable region pointer - &mut T - to a mutable unsafe pointer - *mut T.
to_unsafe_ptr
fn to_unsafe_ptr<T>(thing: &T) -> *T
Transform a region pointer - &T - to an unsafe pointer - *T.