Struct reclaim::Retired

pub struct Retired<R>(_, _);

A type-erased fat pointer to a retired record.

Methods

impl<R: Reclaim + 'static> Retired<R>

pub unsafe fn new_unchecked<'a, T: 'a>(record: NonNull<T>) -> Self

Creates a new Retired record from a raw pointer.

Safety

The caller has to ensure numerous safety invariants in order for a Retired record to be used safely:

• the given record pointer must point to a valid heap allocated value
• the record must have been allocated as part of a Record of the appropriate [LocalReclaim] implementation
• if the type of the retired record implements Drop and contains any non-static references, it must be ensured that these are not accessed by the drop function.

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

Converts a retired record to a raw pointer.

Since retired records are type-erased trait object (fat) pointers to retired values that should no longer be used, only the 'address' part of the pointer is returned, i.e. a pointer to an ().

pub fn address(&self) -> usize

Returns the numeric representation of the retired record's memory address.

pub unsafe fn reclaim(&mut self)

Reclaims the retired record by dropping it and de-allocating its memory.

Safety

This method must not be called more than once or when some other thread or scope still has some reference to the record.

Trait Implementations

impl<R: Reclaim + 'static> PartialEq<Retired<R>> for Retired<R>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<R: Reclaim + 'static> PartialOrd<Retired<R>> for Retired<R>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<R: Reclaim + 'static> Eq for Retired<R>

impl<R: Reclaim + 'static> Ord for Retired<R>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<R: Reclaim + 'static> Display for Retired<R>

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

Formats the value using the given formatter.

impl<R: Reclaim + 'static> Debug for Retired<R>

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

Formats the value using the given formatter.