pub struct CachePadded<T>(/* private fields */);Expand description
Wraps a value so it occupies a whole cache line, preventing the neighboring fields in a struct from being invalidated when the wrapped atomic is written by another core.
CachePadded<T> has the same size as T rounded up to the target’s
cache-line size; for an AtomicUsize on x86_64 / AArch64 that means
the wrapped value occupies 128 bytes total. Deref / DerefMut hide the
padding from call sites so existing code reading padded.load(...)
stays unchanged.
§Example
use forge_alloc_core::CachePadded;
use core::sync::atomic::{AtomicUsize, Ordering};
struct Stats {
hits: CachePadded<AtomicUsize>,
misses: CachePadded<AtomicUsize>,
}
let s = Stats {
hits: CachePadded::new(AtomicUsize::new(0)),
misses: CachePadded::new(AtomicUsize::new(0)),
};
s.hits.fetch_add(1, Ordering::Relaxed);Implementations§
Source§impl<T> CachePadded<T>
impl<T> CachePadded<T>
Sourcepub const fn new(v: T) -> CachePadded<T>
pub const fn new(v: T) -> CachePadded<T>
Wrap a value with cache-line alignment padding.
Sourcepub fn into_inner(self) -> T
pub fn into_inner(self) -> T
Unwrap, returning the inner value.
Trait Implementations§
Source§impl<T> Debug for CachePadded<T>where
T: Debug,
impl<T> Debug for CachePadded<T>where
T: Debug,
Source§impl<T> Default for CachePadded<T>where
T: Default,
impl<T> Default for CachePadded<T>where
T: Default,
Source§fn default() -> CachePadded<T>
fn default() -> CachePadded<T>
Returns the “default value” for a type. Read more
Source§impl<T> Deref for CachePadded<T>
impl<T> Deref for CachePadded<T>
Auto Trait Implementations§
impl<T> Freeze for CachePadded<T>where
T: Freeze,
impl<T> RefUnwindSafe for CachePadded<T>where
T: RefUnwindSafe,
impl<T> Send for CachePadded<T>where
T: Send,
impl<T> Sync for CachePadded<T>where
T: Sync,
impl<T> Unpin for CachePadded<T>where
T: Unpin,
impl<T> UnsafeUnpin for CachePadded<T>where
T: UnsafeUnpin,
impl<T> UnwindSafe for CachePadded<T>where
T: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more