Struct mycelium_util::sync::CachePadded

source ·
#[repr(align(128))]
pub struct CachePadded<T>(/* private fields */);
Expand description

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§

source§

impl<T> CachePadded<T>

source

pub const fn new(value: T) -> CachePadded<T>

Pads value to the length of a cache line.

source

pub fn into_inner(self) -> T

Unwraps the inner value and returns it.

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn default() -> CachePadded<T>

Returns the “default value” for a type. Read more
source§

impl<T> Deref for CachePadded<T>

§

type Target = T

The resulting type after dereferencing.
source§

fn deref(&self) -> &T

Dereferences the value.
source§

impl<T> DerefMut for CachePadded<T>

source§

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

Mutably dereferences the value.
source§

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

source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

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

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

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

source§

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

source§

impl<T> StructuralPartialEq 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> UnwindSafe for CachePadded<T>
where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

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

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.