pointer - Rust
Skip to main content pointer Primitive Type pointer 1.0.0 Expand description Raw, unsafe pointers, *const T , and *mut T . See also the std::ptr module . Working with raw pointers in Rust is uncommon, typically limited to a few patterns. Raw pointers can be out-of-bounds, unaligned, or null . However, when loading from or storing to a raw pointer, it must be valid for the given access and aligned. When using a field expression, tuple index expression, or array/slice index expression on a raw pointer, it follows the rules of in-bounds pointer arithmetic .
Storing through a raw pointer using *ptr = data calls drop on the old value, so write must be used if the type has drop glue and memory is not already initialized - otherwise drop would be called on the uninitialized memory. Use the null and null_mut functions to create null pointers, and the is_null method of the *const T and *mut T types to check for null. The *const T and *mut T types also define the offset method, for pointer math. § Common ways to create raw pointers § 1.
Coerce a reference ( &T ) or mutable reference ( &mut T ). let my_num: i32 = 10 ; let my_num_ptr: *const i32 = & my_num; let mut my_speed: i32 = 88 ; let my_speed_ptr: *mut i32 = &mut my_speed; To get a pointer to a boxed value, dereference the box: let my_num: Box<i32> = Box::new( 10 ); let my_num_ptr: *const i32 = &* my_num; let mut my_speed: Box<i32> = Box::new( 88 ); let my_speed_ptr: *mut i32 = &mut * my_speed; This does not take ownership of the original allocation and requires no resource management later, but you must not use the pointer after its lifetime. § 2.
Consume a box ( Box<T> ). The into_raw function consumes a box and returns the raw pointer. It doesn’t destroy T or deallocate any memory. let my_speed: Box<i32> = Box::new( 88 ); let my_speed: *mut i32 = Box::into_raw(my_speed); // By taking ownership of the original `Box<T>` though // we are obligated to put it together later to be destroyed. unsafe { drop(Box::from_raw(my_speed)); } Note that here the call to drop is for clarity - it indicates that we are done with the given value and it should be destroyed. § 3.
Create it using &raw Instead of coercing a reference to a raw pointer, you can use the raw borrow operators &raw const (for *const T ) and &raw mut (for *mut T ). These operators allow you to create raw pointers to fields to which you cannot create a reference (without causing undefined behavior), such as an unaligned field. This might be necessary if packed structs or uninitialized memory is involved. #[derive(Debug, Default, Copy, Clone)] #[repr(C, packed)] struct S { aligned: u8, unaligned: u32, } let s = S::default(); let p = & raw const s.unaligned; // not allowed with coercion § 4.
Get it from C. #[allow(unused_extern_crates)] extern crate libc; unsafe { let my_num: *mut i32 = libc::malloc(size_of::<i32>()) as *mut i32; if my_num.is_null() { panic! ( "failed to allocate memory" ); } libc::free(my_num as *mut core::ffi::c_void); } Usually you wouldn’t literally use malloc and free from Rust, but C APIs hand out a lot of pointers generally, so are a common source of raw pointers in Rust. Implementations § Source § impl<T: PointeeSized > *const T 1.0.0 (const: 1.84.0) · Source pub const fn is_null (self) -> bool Returns true if the pointer is null.
Note that, for wide pointers, only the address of the pointee is considered, ignoring the metadata (such as a slice’s length or a trait object’s vtable). Therefore, two pointers that are null may still not compare equal to each other. § Panics during const evaluation If this method is used during const evaluation, and self is a pointer that is offset beyond the bounds of the memory it initially pointed to, then there might not be enough information to determine whether the pointer is null.
This is because the absolute address in memory is not known at compile time. If the nullness of the pointer cannot be determined, this method will panic. In-bounds pointers are never null, so the method will never panic for such pointers. § Examples let s: & str = "Follow the rabbit" ; let ptr: *const u8 = s.as_ptr(); assert! (!ptr.is_null()); 1.38.0 (const: 1.38.0) · Source pub const fn cast <U>(self) -> *const U Casts to a pointer of another type.
1.101.0 · Source pub fn try_cast_aligned <U>(self) -> Option < *const U > Try to cast to a pointer of another type by checking alignment. If the pointer is properly aligned to the target type, it will be cast to the target type. Otherwise, None is returned. § Examples let x = 0u64 ; let aligned: *const u64 = & x; let unaligned = unsafe { aligned.byte_add( 1 ) }; assert! (aligned.try_cast_aligned::<u32>().is_some()); assert! (unaligned.try_cast_aligned::<u32>().is_none()); Source pub const fn with_metadata_of <U>(self, meta: *const U ) -> *const U where U: PointeeSized , 🔬 This is a nightly-only experimental API. ( set_ptr_value #75091 ) Uses the address value in a new pointer of another type.
This operation will ignore the address part of its meta operand and discard existing metadata of self . For pointers to a sized types (thin pointers), this has the same effect as a simple cast. For pointers to an unsized type (fat pointers) this recombines the address with new metadata such as slice lengths or dyn -vtable. The resulting pointer will have provenance of self . This operation is semantically the same as creating a new pointer with the data pointer value of self but the metadata of meta , being fat or thin depending on the meta operand. § Examples This function is primarily useful for enabling pointer arithmetic on potentially fat pointers.
The pointer is cast to a sized pointee to utilize offset operations and then recombined with its own original metadata. #![feature(set_ptr_value)] let arr: [i32; 3 ] = [ 1 , 2 , 3 ]; let mut ptr = arr.as_ptr() as *const dyn Debug; let thin = ptr as *const u8; unsafe { ptr = thin.add( 8 ).with_metadata_of(ptr); println! ( "{:?}" , &* ptr); // will print "3" } § Incorrect usage The provenance from pointers is not combined.
The result must only be used to refer to the address allowed by self . #![feature(set_ptr_value)] let x = 0u32 ; let y = 1u32 ; let x = ( & x) as *const u32; let y = ( & y) as *const u32; let offset = (x as usize - y as usize) / 4 ; let bad = x.wrapping_add(offset).with_metadata_of(y); // This dereference is UB. The pointer only has provenance for `x` but points to `y`. println! ( "{:?}" , unsafe { &* bad }); 1.65.0 (const: 1.65.0) · Source pub const fn cast_mut (self) -> *mut T Changes constness without changing the type.
This is a bit safer than as because it wouldn’t silently change the type if the code is refactored. 1.84.0 · Source pub fn addr (self) -> usize Gets the “address” portion of the pointer. This is similar to self as usize , except that the provenance of the pointer is discarded and not exposed . This means that casting the returned address back to a pointer yields a pointer without provenance , which is undefined behavior to dereference.
To properly restore the lost information and obtain a dereferenceable pointer, use with_addr or map_addr . If using those APIs is not possible because there is no way to preserve a pointer with the required provenance, then Strict Provenance might not be for you. Use pointer-integer casts or expose_provenance and with_exposed_provenance instead. However, note that this makes your code less portable and less amenable to tools that check for compliance with the Rust memory model.
On most platforms this will produce a value with the same bytes as the original pointer, because all the bytes are dedicated to describing the address. Platforms which need to store additional information in the pointer may perform a change of representation to produce a value containing only the address portion of the pointer. What that means is up to the platform to define. This is a Strict Provenance API. 1.84.0 · Source pub fn expose_provenance (self) ->
The rest of this page is on the live site.