Struct reclaim::Record

pub struct Record<T, R: Reclaim> { /* fields omitted */ }

A record type that is associated with a specific reclamation scheme.

Whenever a new Owned or (non-null) Atomic is created, a value of this type is allocated on the heap as a wrapper for the desired record. The record and its header are never directly exposed to the data structure using a given memory reclamation scheme and should only be accessed by the reclamation scheme itself.

Methods

impl<T, R: Reclaim> Record<T, R>

pub fn new(elem: T) -> Self

Creates a new record with the specified elem and a default header.

pub fn with_header(elem: T, header: R::RecordHeader) -> Self

Creates a new record with the specified elem and header.

pub fn header(&self) -> &R::RecordHeader

Returns a reference to the record's header.

pub fn elem(&self) -> &T

Returns a reference to the record's element.

pub unsafe fn from_raw_non_null(elem: NonNull<T>) -> NonNull<Self>

Calculates the address of the Record for the given pointer to a wrapped non-nullable elem and returns the resulting pointer.

Safety

The elem pointer must be a valid pointer to an instance of T that was constructed as part of a Record. Otherwise, the pointer arithmetic used to determine the address will result in a pointer to unrelated memory, which is likely to lead to undefined behaviour.

pub unsafe fn from_raw(elem: *mut T) -> NonNull<Self>

Calculates the address of the Record for the given pointer to a wrapped elem and returns the resulting pointer.

Safety

The elem pointer must be a valid pointer to an instance of T that was constructed as part of a Record. Otherwise, the pointer arithmetic used to determine the address will result in a pointer to unrelated memory, which is likely to lead to undefined behaviour.

pub unsafe fn header_from_raw<'a>(elem: *mut T) -> &'a R::RecordHeader

Returns a reference to the header for the record at the pointed-to location of the pointer elem.

Safety

The pointer elem must be a valid pointer to an instance of T that was allocated as part of a Record. Otherwise, the pointer arithmetic used to calculate the header's address will be incorrect and lead to undefined behavior.

pub unsafe fn header_from_raw_non_null<'a>(
    elem: NonNull<T>
) -> &'a R::RecordHeader

Returns a reference to the header for the record at the pointed-to location of the non-nullable pointer elem.

Safety

The pointer elem must be a valid pointer to an instance of T that was allocated as part of a Record. Otherwise, the pointer arithmetic used to calculate the header's address will be incorrect and lead to undefined behavior.

pub fn offset_header() -> usize

Returns the offset in bytes from the address of a record to its header field.

pub fn offset_elem() -> usize

Returns the offset in bytes from the address of a record to its element field.