Struct safer_ffi::ptr::NonNullMut
source · [−]#[repr(transparent)]pub struct NonNullMut<T>(pub NonNull<T>, pub PhantomInvariant<T>);
Tuple Fields
0: NonNull<T>
1: PhantomInvariant<T>
Implementations
sourceimpl<T> NonNullMut<T>
impl<T> NonNullMut<T>
pub fn as_ptr(&self) -> *const T
pub fn cast<U>(self: NonNullMut<T>) -> NonNullMut<U>
sourceimpl<T> NonNullMut<T>
impl<T> NonNullMut<T>
pub fn as_mut_ptr(&mut self) -> *mut T
pub fn copy(self: &mut NonNullMut<T>) -> NonNullMut<T>
Methods from Deref<Target = NonNull<T>>
1.25.0 · sourcepub unsafe fn as_ref<'a>(&self) -> &'a T
pub unsafe fn as_ref<'a>(&self) -> &'a T
Returns a shared reference to the value. If the value may be uninitialized, as_uninit_ref
must be used instead.
For the mutable counterpart see as_mut
.
Safety
When calling this method, you have to ensure that all of the following is true:
-
The pointer must be properly aligned.
-
It must be “dereferenceable” in the sense defined in the module documentation.
-
The pointer must point to an initialized instance of
T
. -
You must enforce Rust’s aliasing rules, since the returned lifetime
'a
is arbitrarily chosen and does not necessarily reflect the actual lifetime of the data. In particular, while this reference exists, the memory the pointer points to must not get mutated (except insideUnsafeCell
).
This applies even if the result of this method is unused! (The part about being initialized is not yet fully decided, but until it is, the only safe approach is to ensure that they are indeed initialized.)
Examples
use std::ptr::NonNull;
let mut x = 0u32;
let ptr = NonNull::new(&mut x as *mut _).expect("ptr is null!");
let ref_x = unsafe { ptr.as_ref() };
println!("{ref_x}");
1.25.0 · sourcepub unsafe fn as_mut<'a>(&mut self) -> &'a mut T
pub unsafe fn as_mut<'a>(&mut self) -> &'a mut T
Returns a unique reference to the value. If the value may be uninitialized, as_uninit_mut
must be used instead.
For the shared counterpart see as_ref
.
Safety
When calling this method, you have to ensure that all of the following is true:
-
The pointer must be properly aligned.
-
It must be “dereferenceable” in the sense defined in the module documentation.
-
The pointer must point to an initialized instance of
T
. -
You must enforce Rust’s aliasing rules, since the returned lifetime
'a
is arbitrarily chosen and does not necessarily reflect the actual lifetime of the data. In particular, while this reference exists, the memory the pointer points to must not get accessed (read or written) through any other pointer.
This applies even if the result of this method is unused! (The part about being initialized is not yet fully decided, but until it is, the only safe approach is to ensure that they are indeed initialized.)
Examples
use std::ptr::NonNull;
let mut x = 0u32;
let mut ptr = NonNull::new(&mut x).expect("null pointer");
let x_ref = unsafe { ptr.as_mut() };
assert_eq!(*x_ref, 0);
*x_ref += 2;
assert_eq!(*x_ref, 2);
Trait Implementations
sourceimpl<T> Debug for NonNullMut<T>
impl<T> Debug for NonNullMut<T>
sourceimpl<T> Deref for NonNullMut<T>
impl<T> Deref for NonNullMut<T>
sourceimpl<T> DerefMut for NonNullMut<T>
impl<T> DerefMut for NonNullMut<T>
sourcefn deref_mut(self: &mut NonNullMut<T>) -> &mut NonNull<T>
fn deref_mut(self: &mut NonNullMut<T>) -> &mut NonNull<T>
sourceimpl<'lt, T: 'lt> From<&'lt mut T> for NonNullMut<T>
impl<'lt, T: 'lt> From<&'lt mut T> for NonNullMut<T>
sourcefn from(it: &'lt mut T) -> NonNullMut<T>
fn from(it: &'lt mut T) -> NonNullMut<T>
sourceimpl<T> From<NonNull<T>> for NonNullMut<T>
impl<T> From<NonNull<T>> for NonNullMut<T>
Auto Trait Implementations
impl<T> RefUnwindSafe for NonNullMut<T>where
T: RefUnwindSafe,
impl<T> !Send for NonNullMut<T>
impl<T> !Sync for NonNullMut<T>
impl<T> Unpin for NonNullMut<T>
impl<T> UnwindSafe for NonNullMut<T>where
T: RefUnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<T> CompatExt for T
impl<T> CompatExt for T
sourceimpl<T> ConcreteReprC for Twhere
<T as ReprC>::CLayout: CType<OPAQUE_KIND = Concrete>,
T: ReprC + ?Sized,
impl<T> ConcreteReprC for Twhere
<T as ReprC>::CLayout: CType<OPAQUE_KIND = Concrete>,
T: ReprC + ?Sized,
type ConcreteCLayout = <T as ReprC>::CLayout
sourceimpl<T> FitForCBox for T
impl<T> FitForCBox for T
type CBoxWrapped = Box_<T>
type CBoxWrapped = Box_<T>
alloc
only.sourceimpl<T> ManuallyDropMut for T
impl<T> ManuallyDropMut for T
type Ret = ManuallyDrop<T>
fn manually_drop_mut(&'__ mut self) -> &'__ mut ManuallyDrop<T>
sourceimpl<T> UpcastAny for Twhere
T: 'static,
impl<T> UpcastAny for Twhere
T: 'static,
sourcefn upcast_any(&self) -> &(dyn Any + 'static)
fn upcast_any(&self) -> &(dyn Any + 'static)
headers
only.