Struct cpu_affinity::PerLogicalCoreData

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

Data with an item per logical core in use by the process.

Methods

impl<T> PerLogicalCoreData<T>

pub fn empty(logical_cores: &LogicalCores) -> Self

Creates an empty set of logical core data.

pub fn new(     logical_cores: &LogicalCores,     constructor: impl FnMut(u16) -> T ) -> Self

constructor is called for each defined logical core in logical_cores; it is passed the logical core's identifier.

pub fn get(&self, logical_core_identifier: u16) -> Option<&T>

Gets the data for a particular logical core.

If the logical core 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_mut(&mut self, logical_core_identifier: u16) -> Option<&mut T>

Gets the mutable data for a particular logical core.

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

pub fn get_mut_or(     &mut self,     logical_core_identifier: u16,     default_logical_core_identifier: impl FnOnce() -> u16 ) -> &mut T

Gets the mutable data for a particular logical core; if no data for that core, gets it for the default_logical_core_identifier.

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

pub fn set(&mut self, logical_core_identifier: u16, value: T)

Sets the current value, discarding the old one.

pub fn take(&mut self, logical_core_identifier: u16) -> Option<T>

Takes the data for a particular logical core.

If the logical core 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 replace(&mut self, logical_core_identifier: u16, value: T) -> Option<T>

Replaces the current value, returning the old one.

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

Iterates over all entries that are not None.

pub fn map<V>(     self,     mapper: impl FnMut(u16, T) -> V ) -> PerLogicalCoreData<V>

Maps from T to V assuming that entries with Some() in them are mappable.

mapper is called for each defined (ie is Some(T)) logical core in logical_cores; it is passed the logical core's identifier and the old value.

Trait Implementations

impl<T: Eq> Eq for PerLogicalCoreData<T>

impl<T: PartialOrd> PartialOrd<PerLogicalCoreData<T>> for PerLogicalCoreData<T>

fn partial_cmp(&self, other: &PerLogicalCoreData<T>) -> Option<Ordering>

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

fn lt(&self, other: &PerLogicalCoreData<T>) -> bool

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

fn le(&self, other: &PerLogicalCoreData<T>) -> bool

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

fn gt(&self, other: &PerLogicalCoreData<T>) -> bool

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

fn ge(&self, other: &PerLogicalCoreData<T>) -> bool

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

impl<T: PartialEq> PartialEq<PerLogicalCoreData<T>> for PerLogicalCoreData<T>

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

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

fn ne(&self, other: &PerLogicalCoreData<T>) -> bool

This method tests for !=.

impl<T: Clone> Clone for PerLogicalCoreData<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Ord> Ord for PerLogicalCoreData<T>

fn cmp(&self, other: &PerLogicalCoreData<T>) -> 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.

impl<T: Debug> Debug for PerLogicalCoreData<T>

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

Formats the value using the given formatter.

impl<T> DerefMut for PerLogicalCoreData<T>

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

Mutably dereferences the value.

impl<T> Deref for PerLogicalCoreData<T>

type Target = [Option<T>]

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: Hash> Hash for PerLogicalCoreData<T>

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

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<T> Index<u16> for PerLogicalCoreData<T>

type Output = Option<T>

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<u16> for PerLogicalCoreData<T>

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

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