Struct safer_ffi::ptr::NonNullRef

#[repr(transparent)]
pub struct NonNullRef<T>(pub NonNull<T>);

Tuple Fields

0: NonNull<T>

Implementations

impl<T> NonNullRef<T>

pub fn as_ptr(&self) -> *const T

pub fn cast<U>(self: NonNullRef<T>) -> NonNullRef<U>

Methods from Deref<Target = NonNull<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 inside UnsafeCell).

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}");

Trait Implementations

impl<__> Clone for NonNullRef<__>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for NonNullRef<T>

fn fmt(self: &NonNullRef<T>, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Deref for NonNullRef<T>

type Target = NonNull<T>

The resulting type after dereferencing.

fn deref(self: &NonNullRef<T>) -> &NonNull<T>

Dereferences the value.

impl<'lt, T: 'lt> From<&'lt T> for NonNullRef<T>

fn from(it: &'lt T) -> NonNullRef<T>

Converts to this type from the input type.

impl<'lt, T: 'lt> From<&'lt mut T> for NonNullRef<T>

fn from(it: &'lt mut T) -> NonNullRef<T>

Converts to this type from the input type.

impl<T> From<NonNull<T>> for NonNullRef<T>

fn from(it: NonNull<T>) -> Self

Converts to this type from the input type.

impl<T: ReprC> ReprC for NonNullRef<T>

type CLayout = *const <T as ReprC>::CLayout

The CType having the same layout as Self.

fn is_valid(it: &*const T::CLayout) -> bool

Sanity checks that can be performed on an instance of the CType layout.

impl<__> Copy for NonNullRef<__>