Struct CachePadded

#[repr(align(64))]
pub struct CachePadded<T>(/* private fields */);

Aligns the wrapped value to the size of a cache line.

This is used to avoid false sharing for values that may be accessed concurrently.

Size/Alignment

The size and alignment of this type depends on the target architecture, and on whether or not the no-cache-pad feature flag is enabled.

When the no-cache-pad crate feature flag is enabled, this is simply a no-op wrapper struct. This is intended for use on useful for platforms with no data cache, such as many Cortex-M targets.

In other cases, this type is always aligned to the size of a cache line, based on the target architecture. On x86_64/aarch64, a cache line is 128 bytes. On all other targets, a cache line is assumed to 64 bytes long. This type’s size will always be a multiple of the cache line size; if the wrapped type is longer than the alignment of a cache line, then this type will be padded to multiple cache lines.

Implementations

impl<T> CachePadded<T>

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

Pads value to the length of a cache line.

pub fn into_inner(self) -> T

Unwraps the inner value and returns it.

Trait Implementations

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

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

Returns a copy 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: 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: Copy> Copy for CachePadded<T>

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

impl<T> StructuralPartialEq for CachePadded<T>