Struct crossbeam::utils::CachePadded

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

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.

Cache lines are assumed to be 64 bytes on all architectures.

Size and alignment

The size of CachePadded<T> is the smallest multiple of 64 bytes large enough to accommodate a value of type T.

The alignment of CachePadded<T> is the maximum of 64 bytes 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.

Trait Implementations

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

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

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> DerefMut for CachePadded<T>

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Mutably dereferences the value.

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

fn default() -> CachePadded<T>

Returns the "default value" for a type.

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

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

Formats the value using the given formatter.

impl<T> Deref for CachePadded<T>

type Target = T

The resulting type after dereferencing.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn deref(&self) -> &T

Dereferences the value.

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

impl<T> From<T> for CachePadded<T>

fn from(t: T) -> CachePadded<T>

Performs the conversion.