Struct kernel::types::ARef

pub struct ARef<T: AlwaysRefCounted> { /* private fields */ }

An owned reference to an always-reference-counted object.

The object’s reference count is automatically decremented when an instance of ARef is dropped. It is also automatically incremented when a new instance is created via ARef::clone.

Invariants

The pointer stored in ptr is non-null and valid for the lifetime of the ARef instance. In particular, the ARef instance owns an increment on the underlying object’s reference count.

Implementations

impl<T: AlwaysRefCounted> ARef<T>

pub unsafe fn from_raw(ptr: NonNull<T>) -> Self

Creates a new instance of ARef.

It takes over an increment of the reference count on the underlying object.

Safety

Callers must ensure that the reference count was incremented at least once, and that they are properly relinquishing one increment. That is, if there is only one increment, callers must not use the underlying object anymore – it is only safe to do so via the newly created ARef.

Trait Implementations

impl<T: AlwaysRefCounted> Clone for ARef<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: AlwaysRefCounted> Deref for ARef<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: AlwaysRefCounted> Drop for ARef<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: AlwaysRefCounted> From<&T> for ARef<T>

fn from(b: &T) -> Self

Converts to this type from the input type.

impl<T: AlwaysRefCounted + Sync + Send> Send for ARef<T>

impl<T: AlwaysRefCounted + Sync + Send> Sync for ARef<T>