Struct kernel::sync::Ref

pub struct Ref<T: ?Sized> { /* private fields */ }

A reference-counted pointer to an instance of T.

The reference count is incremented when new instances of Ref are created, and decremented when they are dropped. When the count reaches zero, the underlying T is also dropped.

Invariants

The reference count on an instance of Ref is always non-zero. The object pointed to by Ref is always pinned.

Implementations

impl<T> Ref<T>

pub fn try_new(contents: T) -> Result<Self>

Constructs a new reference counted instance of T.

pub fn into_usize(obj: Self) -> usize

Deconstructs a Ref object into a usize.

It can be reconstructed once via Ref::from_usize.

pub unsafe fn borrow_usize<'a>(encoded: usize) -> RefBorrow<'a, T>

Borrows a Ref instance previously deconstructed via Ref::into_usize.

Safety

encoded must have been returned by a previous call to Ref::into_usize. Additionally, Ref::from_usize can only be called after all instances of RefBorrow have been dropped.

pub unsafe fn from_usize(encoded: usize) -> Self

Recreates a Ref instance previously deconstructed via Ref::into_usize.

Safety

encoded must have been returned by a previous call to Ref::into_usize. Additionally, it can only be called once for each previous call to Ref::into_usize.

impl<T: ?Sized> Ref<T>

pub fn ptr_eq(a: &Self, b: &Self) -> bool

Determines if two reference-counted pointers point to the same underlying instance of T.

pub fn into_raw(obj: Self) -> *const T

Deconstructs a Ref object into a raw pointer.

It can be reconstructed once via Ref::from_raw.

pub unsafe fn from_raw(ptr: *const T) -> Self

Recreates a Ref instance previously deconstructed via Ref::into_raw.

This code relies on the repr(C) layout of structs as described in https://doc.rust-lang.org/reference/type-layout.html#reprc-structs.

Safety

ptr must have been returned by a previous call to Ref::into_raw. Additionally, it can only be called once for each previous call to Ref::into_raw.

pub fn as_ref_borrow(&self) -> RefBorrow<'_, T>

Returns a RefBorrow from the given Ref.

This is useful when the argument of a function call is a RefBorrow (e.g., in a method receiver), but we have a Ref instead. Getting a RefBorrow is free when optimised.

Trait Implementations

impl<T: ?Sized> AsRef<T> for Ref<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: ?Sized> Clone for Ref<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> Deref for Ref<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: DeviceRemoval> DeviceRemoval for Ref<T>

fn device_remove(&self)

Cleans resources up when the device is removed.

impl<T: ?Sized> Drop for Ref<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: ?Sized> From<Pin<UniqueRef<T>>> for Ref<T>

fn from(item: Pin<UniqueRef<T>>) -> Self

Converts to this type from the input type.

impl<T: ?Sized> From<RefBorrow<'_, T>> for Ref<T>

fn from(b: RefBorrow<'_, T>) -> Self

Converts to this type from the input type.

impl<T: ?Sized> From<UniqueRef<T>> for Ref<T>

fn from(item: UniqueRef<T>) -> Self

Converts to this type from the input type.

impl<T: GetLinks + ?Sized> GetLinks for Ref<T>

type EntryType = <T as GetLinks>::EntryType

The type of the entries in the list.

fn get_links(data: &Self::EntryType) -> &Links<Self::EntryType>

Returns the links to be used when linking an entry within a list.

impl<T: ?Sized> GetLinksWrapped for Ref<T> where
    Ref<T>: GetLinks, 

type Wrapped = Ref<<Ref<T> as GetLinks>::EntryType>

Specifies which wrapper (e.g., Box and Arc) wraps the list entries.

impl<T: 'static> PointerWrapper for Ref<T>

type Borrowed<'a> = RefBorrow<'a, T>

Type of values borrowed between calls to PointerWrapper::into_pointer and PointerWrapper::from_pointer.

fn into_pointer(self) -> *const c_void

Returns the raw pointer.

unsafe fn borrow<'a>(ptr: *const c_void) -> RefBorrow<'a, T>

Returns a borrowed value.

unsafe fn from_pointer(ptr: *const c_void) -> Self

Returns the instance back from the raw pointer.

unsafe fn borrow_mut<T: PointerWrapper>(
    ptr: *const c_void
) -> ScopeGuard<T, fn(_: T)>

Returns a mutably borrowed value.

impl<T> TryFrom<Vec<T, Global>> for Ref<[T]>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: Vec<T>) -> Result<Self>

Performs the conversion.

impl<T: ?Sized> Wrapper<T> for Ref<T>

fn into_pointer(self) -> NonNull<T>

Converts the wrapped object into a pointer that represents it.

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

Converts the object back from the pointer representation.

fn as_ref(&self) -> &T

Returns a reference to the wrapped object.

impl<T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Ref<U>> for Ref<T>

impl<T: ?Sized + Unsize<U>, U: ?Sized> DispatchFromDyn<Ref<U>> for Ref<T>

impl<T: ?Sized + Sync + Send> Send for Ref<T>

impl<T: ?Sized + Sync + Send> Sync for Ref<T>