Struct crossbeam_utils::cache_padded::CachePadded

[+] Show declaration

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

[−] Expand description

Pads T to the length of a cache line.

Sometimes concurrent programming requires a piece of data to be padded out to the size of a cacheline to avoid "false sharing": cache lines being invalidated due to unrelated concurrent activity. Use this type when you want to avoid cache locality.

At the moment, cache lines are assumed to be 64 bytes on all architectures.

Size and alignment

By default, the size of CachePadded<T> is 64 bytes. If T is larger than that, then CachePadded::<T>::new will panic. Alignment of CachePadded<T> is the same as that of T.

However, if the nightly feature is enabled, arbitrarily large types T can be stored inside a CachePadded<T>. The size will then be a multiple of 64 at least the size of T, and the alignment will be the maximum of 64 and the alignment of T.

Methods

impl<T> CachePadded<T>[−]

pub fn new(t: T) -> CachePadded<T>[−]

Pads a value to the length of a cache line.

Panics

If nightly is not enabled and T is larger than 64 bytes, this function will panic.

Trait Implementations

impl<T: Sync> Sync for CachePadded<T>

impl<T: Default> Default for CachePadded<T>[+]

[+] Show hidden undocumented items

fn default() -> Self[−]

Returns the "default value" for a type.

impl<T: Clone> Clone for CachePadded<T>[+]

[+] Show hidden undocumented items

fn clone(&self) -> Self[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl<T: Send> Send for CachePadded<T>

impl<T> From<T> for CachePadded<T>[+]

[+] Show hidden undocumented items

fn from(t: T) -> Self[−]

Performs the conversion.

impl<T> Drop for CachePadded<T>[+]

[+] Show hidden undocumented items

fn drop(&mut self)[−]

Executes the destructor for this type.

impl<T> Deref for CachePadded<T>[+]

[+] Show hidden undocumented items

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T[−]

Dereferences the value.

impl<T> DerefMut for CachePadded<T>[+]

[+] Show hidden undocumented items

fn deref_mut(&mut self) -> &mut T[−]

Mutably dereferences the value.

impl<T: Debug> Debug for CachePadded<T>[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.