Struct swiss_army_knife::bit_set::PerBitSetAwareData

pub struct PerBitSetAwareData<BSA: BitSetAware, PerBitSetAware> { /* fields omitted */ }

Data (PerBitSetAware) with an item per BitSetAware, such as a HyperThread, in use by the process.

Implementations

impl<BSA: BitSetAware, PerBitSetAware> PerBitSetAwareData<BSA, PerBitSetAware>

pub fn new(
    bit_set: &BitSet<BSA>,
    constructor: impl FnMut(BSA) -> PerBitSetAware
) -> Self

constructor is called for each defined BitSetAware in bit_set; it is passed the BitSetAware.

pub fn from_iterator<R>(
    constructor: impl Iterator<Item = Result<(BSA, PerBitSetAware), R>>
) -> Result<Self, R>

constructor is called for each defined BitSetAware in bit_set; it is passed the BitSetAware.

pub fn get(&self, bit_set_aware: BSA) -> Option<&PerBitSetAware>

Gets the data for a particular BitSetAware.

If the BitSetAware does not exist (or does not have assigned data), returns None; this can happen on Linux if using the SO_INCOMING_CPU socket option, which can map to a CPU not assigned to the process.

pub fn get_unchecked_safe(&self, bit_set_aware: BSA) -> &PerBitSetAware

Gets the data for a particular BitSetAware.

pub fn get_or(
    &self,
    bit_set_aware: BSA,
    default_bit_set_aware: BSA
) -> (&PerBitSetAware, BSA)

Gets the data for a particular BitSetAware; if no datum for that gets a datum for default_bit_set_aware.

If the BitSetAware does not exist (or does not have assigned data), returns None; this can happen on Linux if using the SO_INCOMING_CPU socket option with HyperThreads, which can return an index for a CPU not assigned to the process.

Does not validate default_bit_set_aware has a datum unless compiled as a debug build.

pub fn set(&mut self, bit_set_aware: BSA, value: PerBitSetAware)

Sets the current value, discarding the old one.

pub fn take(&mut self, bit_set_aware: BSA) -> Option<PerBitSetAware>

Takes the data for a particular BitSetAware.

If the BitSetAware does not exist (or does not have assigned data), returns None; this can happen on Linux if using the SO_INCOMING_CPU socket option with PerBitSetAwareData<HyperThread>, which can map to a HyperThread not assigned to the process.

pub fn replace(
    &mut self,
    bit_set_aware: BSA,
    value: PerBitSetAware
) -> Option<PerBitSetAware>

Replaces the current value, returning the old one.

pub fn bit_set_aware_indices<'a>(&'a self) -> impl Iterator<Item = BSA> + 'a

Iterates over all indices.

pub fn bit_set_aware_items<'a>(
    &'a self
) -> impl Iterator<Item = (BSA, &'a PerBitSetAware)> + 'a

Iterates over all entries.

pub fn map_ref<'a, NewPerBitSetAware: 'a>(
    &'a self,
    mapper: impl FnMut(BSA, &'a PerBitSetAware) -> NewPerBitSetAware
) -> PerBitSetAwareData<BSA, NewPerBitSetAware>

Maps from PerBitSetAware to NewPerBitSetAware.

pub fn map<NewPerBitSetAware>(
    self,
    mapper: impl FnMut(BSA, PerBitSetAware) -> NewPerBitSetAware
) -> PerBitSetAwareData<BSA, NewPerBitSetAware>

Maps from PerBitSetAware to NewPerBitSetAware.

Trait Implementations

impl<BSA: Clone + BitSetAware, PerBitSetAware: Clone> Clone for PerBitSetAwareData<BSA, PerBitSetAware>

fn clone(&self) -> PerBitSetAwareData<BSA, PerBitSetAware>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<BSA: Debug + BitSetAware, PerBitSetAware: Debug> Debug for PerBitSetAwareData<BSA, PerBitSetAware>

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

Formats the value using the given formatter.

impl<BSA: BitSetAware, PerBitSetAware> Deref for PerBitSetAwareData<BSA, PerBitSetAware>

type Target = [Option<PerBitSetAware>]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<BSA: BitSetAware, PerBitSetAware> DerefMut for PerBitSetAwareData<BSA, PerBitSetAware>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, BSA: BitSetAware, PerBitSetAware> Deserialize<'de> for PerBitSetAwareData<BSA, PerBitSetAware> where
    BSA: Deserialize<'de>,
    PerBitSetAware: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<BSA: Hash + BitSetAware, PerBitSetAware: Hash> Hash for PerBitSetAwareData<BSA, PerBitSetAware>

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, 

Feeds a slice of this type into the given Hasher.

impl<BSA: BitSetAware, PerBitSetAware> Index<BSA> for PerBitSetAwareData<BSA, PerBitSetAware>

type Output = Option<PerBitSetAware>

The returned type after indexing.

fn index(&self, index: BSA) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<BSA: BitSetAware, PerBitSetAware> IndexMut<BSA> for PerBitSetAwareData<BSA, PerBitSetAware>

fn index_mut(&mut self, index: BSA) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<BSA: Ord + BitSetAware, PerBitSetAware: Ord> Ord for PerBitSetAwareData<BSA, PerBitSetAware>

fn cmp(&self, other: &PerBitSetAwareData<BSA, PerBitSetAware>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<BSA: PartialEq + BitSetAware, PerBitSetAware: PartialEq> PartialEq<PerBitSetAwareData<BSA, PerBitSetAware>> for PerBitSetAwareData<BSA, PerBitSetAware>

fn eq(&self, other: &PerBitSetAwareData<BSA, PerBitSetAware>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &PerBitSetAwareData<BSA, PerBitSetAware>) -> bool

This method tests for !=.

impl<BSA: PartialOrd + BitSetAware, PerBitSetAware: PartialOrd> PartialOrd<PerBitSetAwareData<BSA, PerBitSetAware>> for PerBitSetAwareData<BSA, PerBitSetAware>

fn partial_cmp(
    &self,
    other: &PerBitSetAwareData<BSA, PerBitSetAware>
) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<BSA: BitSetAware, PerBitSetAware> Serialize for PerBitSetAwareData<BSA, PerBitSetAware> where
    BSA: Serialize,
    PerBitSetAware: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<BSA: Eq + BitSetAware, PerBitSetAware: Eq> Eq for PerBitSetAwareData<BSA, PerBitSetAware>

impl<BSA: BitSetAware, PerBitSetAware> StructuralEq for PerBitSetAwareData<BSA, PerBitSetAware>

impl<BSA: BitSetAware, PerBitSetAware> StructuralPartialEq for PerBitSetAwareData<BSA, PerBitSetAware>