Enum Affinity 

#[non_exhaustive]
pub enum Affinity {
    Disabled,
    Cpu,
    Core,
    Soft,
}

CPU affinity of worker threads.

Workers are placed on one logical CPU of each physical core first, spread across NUMA nodes and shared L3 caches, and on the remaining SMT siblings after that. On hybrid CPUs, performance cores are used before efficiency cores. When there are more workers than CPUs, the placement starts over.

The default is Soft on Windows and Core on other platforms. Affinity is supported on Windows, Linux and Android, other platforms ignore it.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Disabled

Worker threads are not pinned, the OS scheduler places them.

Cpu

Pins each worker to one logical CPU.

Core

Pins each worker to the logical CPUs of one physical core.

The scheduler can move the worker between the SMT siblings of its core. Works like Cpu on CPUs without SMT.

Soft

Sets the preferred CPU of each worker without pinning it.

On Windows, this sets the ideal processor of the worker thread. The scheduler runs the worker there when that CPU is free, and on another CPU otherwise. On machines with several processor groups, the worker is also kept in the group of its CPU. Other platforms have no such hint, there it works like Core.

Trait Implementations

impl Clone for Affinity

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Affinity

impl Debug for Affinity

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

Formats the value using the given formatter.

impl Default for Affinity

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Affinity

impl Hash for Affinity

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 PartialEq for Affinity

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Affinity