Struct CachePadded 

#[repr(align(64))]
pub struct CachePadded<T>(pub T);

In concurrent programming, false sharing is a performance-degrading situation that can arise when two or more cores are modifying different variables that reside on the same cache line.

Cache lines are assumed to be N bytes long, where N depends on the architecture:

• x86_64, aarch64 and powerpc: 64 bytes, but N is 128 as prefetching pulls pairs of cache lines on some CPUs.
• arm, mips, mips32r6, mips64, mips64r6, sparc and hexagon: 32 bytes
• m68k: 16 bytes
• s390x: 256 bytes
• others: 64 bytes. Just some default for other architectures.

Note that alignment MAY be different than cache line size of the actual CPU the program runs on, as cache line size vary between CPUs with the same architecture.

This structure contains a single value of type T that is aligned to cache lines, removing false sharing. It derives common traits for convenience.

Tuple Fields

0: T

Trait Implementations

impl<T: Clone> Clone for CachePadded<T>

fn clone(&self) -> CachePadded<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for CachePadded<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for CachePadded<T>

fn default() -> CachePadded<T>

Returns the “default value” for a type.

impl<T> Deref for CachePadded<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for CachePadded<T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T: Hash> Hash for CachePadded<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 CachePadded<T>

fn cmp(&self, other: &CachePadded<T>) -> 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.

impl<T: PartialEq> PartialEq for CachePadded<T>

fn eq(&self, other: &CachePadded<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for CachePadded<T>

fn partial_cmp(&self, other: &CachePadded<T>) -> 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<T: Copy> Copy for CachePadded<T>

impl<T: Eq> Eq for CachePadded<T>

impl<T> StructuralPartialEq for CachePadded<T>