Struct swym::tptr::TPtr

pub struct TPtr<T> { /* fields omitted */ }

Experimental building block for recursive data structures.

This should be used in places to where single threaded data structures would have Option<NonNull<T>>/*mut T, and is similarly low level.

Methods

impl<T> TPtr<T>

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

Constructs a new TPtr from the provided pointer.

pub const fn null() -> Self

Constructs a TPtr initialized to null.

pub fn into_inner(self) -> *const T

Consumes the TPtr returning the underlying pointer.

pub fn borrow_mut(&mut self) -> &mut *const T

Gets mutable access to the TPtr.

pub fn as_ptr<'tcell>(
    &'tcell self,
    tx: &impl Read<'tcell>,
    ordering: Ordering
) -> Result<*const T, Error>

Retrieve the contained pointer.

impl<T: Send + Sync + 'static> TPtr<T>

pub fn publish_box<'tcell>(
    &'tcell self,
    tx: &mut impl Write<'tcell>,
    value: Box<T>
) -> Result<(), SetError<Box<T>>>

Publishes a new pointer from an owned Box.

Note

If the transaction fails at any later point, the memory is freed using Box::from_raw. No cleanup/deallocation of the previously contained pointer is performed.

pub fn publish<'tcell, F: FnOnce(*mut T) + Copy + 'static>(
    &'tcell self,
    tx: &mut impl Write<'tcell>,
    publisher: Publisher<T, F>
) -> Result<(), SetError<Publisher<T, F>>>

Publishes a new pointer.

Note

If the transaction fails at any later point, the desctructor with the pulisher is run. Publishing No cleanup/deallocation of the previously container pointer is performed.

pub unsafe fn privatize_as_box<'tcell>(
    tx: &mut impl Write<'tcell>,
    value: *const T
)

Queues up drop_in_place/deallocation of the raw pointer to happen at some later time, if and only if the transaction succeeds.

Safety

The raw pointer must have been previously allocated via Box::new, and not yet queued for privatization or deallocated via other means.

pub unsafe fn privatize<'tcell, F: FnOnce(*mut T) + Copy + Send + 'static>(
    tx: &mut impl Write<'tcell>,
    value: *const T,
    privatizer: F
)

Queues up a custom desctructor to happen at some later time, if and only if the transaction succeeds.

pub fn set<'tcell>(
    &'tcell self,
    tx: &mut impl Write<'tcell>,
    value: *const T
) -> Result<(), Error>

Sets the contained pointer.

Note

No cleanup/deallocation of the previously contained pointer is performed.

Trait Implementations

impl<T> Default for TPtr<T>

fn default() -> Self

Returns the "default value" for a type.