Struct Unique

pub struct Unique<T: ?Sized> {
    pointer: NonNull<T>,
    _marker: PhantomData<T>,
}

🔬This is a nightly-only experimental API. (kernel_ptr)

Fields

pointer: NonNull<T>

🔬This is a nightly-only experimental API. (kernel_ptr)

_marker: PhantomData<T>

🔬This is a nightly-only experimental API. (kernel_ptr)

Implementations

impl<T: Sized> Unique<T>

pub fn empty() -> Self

🔬This is a nightly-only experimental API. (kernel_ptr)

Creates a new Unique that is dangling, but well-aligned.

This is useful for initializing types which lazily allocate, like Vec::new does.

impl<T: ?Sized> Unique<T>

pub const unsafe fn new(ptr: *mut T) -> Unique<T>

🔬This is a nightly-only experimental API. (kernel_ptr)

Creates a new Unique.

Safety

ptr must be non-null.

pub fn as_ptr(self) -> *mut T

🔬This is a nightly-only experimental API. (kernel_ptr)

Acquires the underlying *mut pointer.

pub unsafe fn as_ref(&self) -> &T

🔬This is a nightly-only experimental API. (kernel_ptr)

Dereferences the content.

The resulting lifetime is bound to self so this behaves “as if” it were actually an instance of T that is getting borrowed. If a longer (unbound) lifetime is needed, use &*my_ptr.ptr().

pub unsafe fn as_mut(&mut self) -> &mut T

🔬This is a nightly-only experimental API. (kernel_ptr)

Mutably dereferences the content.

The resulting lifetime is bound to self so this behaves “as if” it were actually an instance of T that is getting borrowed. If a longer (unbound) lifetime is needed, use &mut *my_ptr.ptr().

Trait Implementations

impl<T: ?Sized> Clone for Unique<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: ?Sized> Pointer for Unique<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Copy for Unique<T>

impl<T: Send + ?Sized> Send for Unique<T>

Unique pointers are Send if T is Send because the data they reference is unaliased. Note that this aliasing invariant is unenforced by the type system; the abstraction using the Unique must enforce it.

impl<T: Sync + ?Sized> Sync for Unique<T>

Unique pointers are Sync if T is Sync because the data they reference is unaliased. Note that this aliasing invariant is unenforced by the type system; the abstraction using the Unique must enforce it.