Struct CacheAligned 

#[repr(align(128))]
pub struct CacheAligned<T>(pub T);

A wrapper that pushes its value onto its own false-sharing sector.

Aligns the wrapped value to DESTRUCTIVE_INTERFERENCE_SIZE so an atomic written by one core cannot invalidate a neighbouring atomic written by another. Because a type’s size is a multiple of its alignment, the wrapper also occupies that many bytes — which is the point: the padding after the value is what keeps the next field off this sector.

Structural traits are derived so the wrapper inherits them whenever the inner T supports them.

Tuple Fields

0: T

Implementations

impl<T> CacheAligned<T>

pub const fn new(value: T) -> Self

Create a new cache-aligned value.

pub const fn get(&self) -> &T

Get a reference to the inner value.

pub fn get_mut(&mut self) -> &mut T

Get a mutable reference to the inner value.

Trait Implementations

impl<T: Clone> Clone for CacheAligned<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Copy> Copy for CacheAligned<T>

impl<T: Debug> Debug for CacheAligned<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for CacheAligned<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Deref for CacheAligned<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for CacheAligned<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: Eq> Eq for CacheAligned<T>

impl<T: Hash> Hash for CacheAligned<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for CacheAligned<T>

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl<T: PartialEq> PartialEq for CacheAligned<T>

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T: PartialOrd> PartialOrd for CacheAligned<T>

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl StateWord for CacheAligned<AtomicU8>

fn pending() -> Self

The word every cell starts at.

fn load(&self, order: Ordering) -> u8

Load the current state.

fn store(&self, value: u8, order: Ordering)

Store a new state.

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

Transition the state, returning the observed value on failure.

fn get_mut(&mut self) -> &mut u8

Exclusive access for Drop, which needs no atomicity.

impl<T: PartialEq> StructuralPartialEq for CacheAligned<T>