Struct AtomicTaggedPtr 

pub struct AtomicTaggedPtr<T> { /* private fields */ }

A platform-adaptive atomic tagged pointer supporting thread-safe ABA protection.

Implementations

impl<T> AtomicTaggedPtr<T>

pub fn new(val: TaggedPtr<T>) -> Self

Creates a new AtomicTaggedPtr initialized with the given tagged pointer.

Examples

use std::ptr::NonNull;
use atomic_tagged_ptr::{AtomicTaggedPtr, TaggedPtr, Tag};

let value = 42;
let ptr = NonNull::new(&value as *const i32 as *mut i32);
let atom = AtomicTaggedPtr::new(TaggedPtr::new(ptr, Tag::new(0)));

pub fn load(&self, order: Ordering) -> TaggedPtr<T>

Loads the current values of the pointer and tag atomically.

Panics

Panics if order is Release or AcqRel.

pub fn store(&self, val: TaggedPtr<T>, order: Ordering)

Stores a new pointer and tag atomically.

Panics

Panics if order is Acquire or AcqRel.

pub fn compare_exchange( &self, current: TaggedPtr<T>, new: TaggedPtr<T>, success: Ordering, failure: Ordering, ) -> Result<TaggedPtr<T>, TaggedPtr<T>>

Exchanges the current values with new ones if the current values match expectations.

On success, returns Ok containing the previous pointer and tag. On failure, returns Err containing the actual loaded pointer and tag.

pub fn compare_exchange_weak( &self, current: TaggedPtr<T>, new: TaggedPtr<T>, success: Ordering, failure: Ordering, ) -> Result<TaggedPtr<T>, TaggedPtr<T>>

Exchanges the current values with new ones using weak semantics.

This is a weaker variant of compare_exchange which is allowed to fail spuriously, but can be significantly more efficient on certain LL/SC-based architectures (such as ARM).

Trait Implementations

impl<T> Debug for AtomicTaggedPtr<T>

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

Formats the value using the given formatter.

impl<T> Default for AtomicTaggedPtr<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Send for AtomicTaggedPtr<T>

impl<T> Sync for AtomicTaggedPtr<T>