Struct AtomicBitFieldVec 

pub struct AtomicBitFieldVec<W: Word + IntoAtomic = usize, B = Vec<<W as IntoAtomic>::AtomicType>> { /* private fields */ }

A tentatively thread-safe vector of bit fields of fixed width (AKA “compact arrays“, “bit array“, etc.)

This implementation provides some concurrency guarantees, albeit not full-fledged thread safety: more precisely, we can guarantee thread-safety if the bit width is a power of two; otherwise, concurrent writes to values that cross word boundaries might end up in different threads succeeding in writing only part of a value. If the user can guarantee that no two threads ever write to the same boundary-crossing value, then no race condition can happen.

See the module documentation for more details.

Implementations

impl<W: Word + IntoAtomic, B> AtomicBitFieldVec<W, B>

pub unsafe fn from_raw_parts(bits: B, bit_width: usize, len: usize) -> Self

Safety

len * bit_width must be between 0 (included) the number of bits in bits (included).

pub fn into_raw_parts(self) -> (B, usize, usize)

pub fn mask(&self) -> W

Returns the mask used to extract values from the vector. This will keep the lowest bit_width bits.

impl<W: Word + IntoAtomic, B: AsRef<[W::AtomicType]>> AtomicBitFieldVec<W, B>

pub fn as_slice(&self) -> &[W::AtomicType]

Returns the backend of the AtomicBitFieldVec as a slice of A, where A is the atomic variant of W.

impl<W: Word + IntoAtomic> AtomicBitFieldVec<W>

where W::AtomicType: AtomicUnsignedInt,

pub fn new(bit_width: usize, len: usize) -> AtomicBitFieldVec<W>

impl<W: Word + IntoAtomic, B: AsRef<[W::AtomicType]>> AtomicBitFieldVec<W, B>

where W::AtomicType: AtomicUnsignedInt + AsBytes,

pub fn reset(&mut self, ordering: Ordering)

👎Deprecated since 0.4.4: reset is deprecated in favor of reset_atomic

Writes zeros in all values.

Trait Implementations

impl<W: Word + IntoAtomic, T: AsRef<[W::AtomicType]>> AtomicBitFieldSlice<W> for AtomicBitFieldVec<W, T>

where W::AtomicType: AtomicUnsignedInt + AsBytes,

fn set_atomic(&self, index: usize, value: W, order: Ordering)

Sets the element of the slice at the specified index.

May panic if the index is not in in [0..len) or the value does not fit in BitWidth::bit_width bits.

fn len(&self) -> usize

See slice::len.

unsafe fn get_atomic_unchecked(&self, index: usize, order: Ordering) -> W

Returns the value at the specified index.

unsafe fn set_atomic_unchecked(&self, index: usize, value: W, order: Ordering)

Sets the element of the slice at the specified index.

fn reset_atomic(&mut self, ordering: Ordering)

Sets all values to zero.

fn par_reset_atomic(&mut self, ordering: Ordering)

Sets all values to zero using a parallel implementation.

fn is_empty(&self) -> bool

See slice::is_empty.

fn get_atomic(&self, index: usize, order: Ordering) -> W

Returns the value at the specified index.

impl<W: Word + IntoAtomic, B> BitWidth<<W as IntoAtomic>::AtomicType> for AtomicBitFieldVec<W, B>

fn bit_width(&self) -> usize

Returns the width of the slice.

impl<W: Clone + Word + IntoAtomic, B: Clone> Clone for AtomicBitFieldVec<W, B>

fn clone(&self) -> AtomicBitFieldVec<W, B>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<W, B> CopyType for AtomicBitFieldVec<W, B>

where B: MemSize, usize: MemSize, W: MemSize + Word + IntoAtomic,

type Copy = False

impl<W: Debug + Word + IntoAtomic, B: Debug> Debug for AtomicBitFieldVec<W, B>

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

Formats the value using the given formatter.

impl<W: Word + IntoAtomic> From<AtomicBitFieldVec<W>> for BitFieldVec<W, Vec<W>>

fn from(value: AtomicBitFieldVec<W, Vec<W::AtomicType>>) -> Self

Converts to this type from the input type.

impl<'a, W: Word + IntoAtomic> From<AtomicBitFieldVec<W, &'a [<W as IntoAtomic>::AtomicType]>> for BitFieldVec<W, &'a [W]>

fn from(value: AtomicBitFieldVec<W, &'a [W::AtomicType]>) -> Self

Converts to this type from the input type.

impl<'a, W: Word + IntoAtomic> From<AtomicBitFieldVec<W, &'a mut [<W as IntoAtomic>::AtomicType]>> for BitFieldVec<W, &'a mut [W]>

fn from(value: AtomicBitFieldVec<W, &'a mut [W::AtomicType]>) -> Self

Converts to this type from the input type.

impl<W: Word + IntoAtomic> From<AtomicBitFieldVec<W, Box<[<W as IntoAtomic>::AtomicType]>>> for BitFieldVec<W, Box<[W]>>

fn from(value: AtomicBitFieldVec<W, Box<[W::AtomicType]>>) -> Self

Converts to this type from the input type.

impl<W: Word + IntoAtomic> From<BitFieldVec<W>> for AtomicBitFieldVec<W, Vec<W::AtomicType>>

fn from(value: BitFieldVec<W, Vec<W>>) -> Self

Converts to this type from the input type.

impl<W: Word + IntoAtomic> From<BitFieldVec<W, Box<[W]>>> for AtomicBitFieldVec<W, Box<[W::AtomicType]>>

fn from(value: BitFieldVec<W, Box<[W]>>) -> Self

Converts to this type from the input type.

impl<W: Hash + Word + IntoAtomic, B: Hash> Hash for AtomicBitFieldVec<W, B>

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<W, B> MemDbgImpl for AtomicBitFieldVec<W, B>

where B: MemDbgImpl, usize: MemDbgImpl, W: MemDbgImpl + Word + IntoAtomic,

fn _mem_dbg_rec_on( &self, _memdbg_writer: &mut impl Write, _memdbg_total_size: usize, _memdbg_max_depth: usize, _memdbg_prefix: &mut String, _memdbg_is_last: bool, _memdbg_flags: DbgFlags, ) -> Result

fn _mem_dbg_depth_on( &self, writer: &mut impl Write, total_size: usize, max_depth: usize, prefix: &mut String, field_name: Option<&str>, is_last: bool, padded_size: usize, flags: DbgFlags, ) -> Result<(), Error>

impl<W, B> MemSize for AtomicBitFieldVec<W, B>

where B: MemSize, usize: MemSize, W: MemSize + Word + IntoAtomic,

fn mem_size(&self, _memsize_flags: SizeFlags) -> usize

Returns the (recursively computed) overall memory size of the structure in bytes.

impl<W: Word + IntoAtomic, T: AsRef<[W::AtomicType]>> SliceByValue for AtomicBitFieldVec<W, T>

where W::AtomicType: AtomicUnsignedInt + AsBytes, Self: AtomicBitFieldSlice<W>,

type Value = W

The type of the values in the slice.

fn len(&self) -> usize

See slice::len.

unsafe fn get_value_unchecked(&self, index: usize) -> Self::Value

See slice::get_unchecked.

fn is_empty(&self) -> bool

See slice::is_empty.

fn index_value(&self, index: usize) -> Self::Value

See the Index implementation for slices.

fn get_value(&self, index: usize) -> Option<Self::Value>

See slice::get.

impl<'a, W: Word + IntoAtomic> TryFrom<BitFieldVec<W, &'a [W]>> for AtomicBitFieldVec<W, &'a [W::AtomicType]>

type Error = CannotCastToAtomicError<W>

The type returned in the event of a conversion error.

fn try_from(value: BitFieldVec<W, &'a [W]>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, W: Word + IntoAtomic> TryFrom<BitFieldVec<W, &'a mut [W]>> for AtomicBitFieldVec<W, &'a mut [W::AtomicType]>

type Error = CannotCastToAtomicError<W>

The type returned in the event of a conversion error.

fn try_from(value: BitFieldVec<W, &'a mut [W]>) -> Result<Self, Self::Error>

Performs the conversion.