Struct glommio::CpuSet

pub struct CpuSet(/* private fields */);

Used to specify a set of permitted CPUs on which executors created by a LocalExecutorPoolBuilder are run.

Please see the documentation for PoolPlacement variants to understand how CpuSet restrictions apply to each variant. CPUs are identified via their CpuLocation.

Implementations

impl CpuSet

pub fn online() -> Result<Self, ()>

Creates a CpuSet representing all CPUs that are online. The function will return an Err if the hardware topology could not be obtained from this machine.

pub fn filter<F>(self, f: F) -> Self

where F: FnMut(&CpuLocation) -> bool,

This method can be used to restrict the CPUs held by CpuSet. The resulting CpuSet will only include CpuLocations for which the provided closure returns true. Note that each call to filter will use as input the set of CPUs previously selected (i.e. the set is not reset on each call).

use glommio::CpuSet;

// get CPUs on NUMA node 0
let cpus = CpuSet::online()
    .expect("Err: please file an issue with glommio")
    .filter(|l| l.numa_node == 0);

println!("The filtered CPUs are: {cpus:#?}");

pub fn is_empty(&self) -> bool

Checks whether the CpuSet is empty.

pub fn iter(&self) -> Iter<'_, CpuLocation>

An iterator visiting all CpuLocations in this CpuSet in arbitrary order.

pub fn len(&self) -> usize

Returns the number of CPUs included in the CpuSet.

pub fn contains(&self, value: &CpuLocation) -> bool

Returns true if the CpuSet contains a CpuLocation.

pub fn difference<'a>( &'a self, other: &'a Self ) -> Difference<'a, CpuLocation, RandomState>

Visits the CpuLocations representing the difference, i.e., the values that are in self but not in the other.

pub fn intersection<'a>( &'a self, other: &'a Self ) -> Intersection<'a, CpuLocation, RandomState>

Visits the CpuLocations representing the intersection, i.e., the values that are both in self and other.

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

Returns true if self has no CpuLocations in common with the other. This is equivalent to checking for an empty intersection.

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

Returns true if this CpuSet is a subset of another, i.e., other contains at least all the values in self.

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

Returns true if this CpuSet is a superset of another, i.e., self contains at least all the values in the other.

pub fn symmetric_difference<'a>( &'a self, other: &'a Self ) -> SymmetricDifference<'a, CpuLocation, RandomState>

Visits the CpuLocations representing the symmetric difference, i.e., the values that are in self or in other but not in both.

pub fn union<'a>( &'a self, other: &'a Self ) -> Union<'a, CpuLocation, RandomState>

Visits the CpuLocations representing the union, i.e., all the values in self or other, without duplicates.

Trait Implementations

impl Clone for CpuSet

fn clone(&self) -> CpuSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CpuSet

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

Formats the value using the given formatter.

impl FromIterator<CpuLocation> for CpuSet

fn from_iter<I: IntoIterator<Item = CpuLocation>>(cpus: I) -> Self

Creates a value from an iterator.

impl Hash for CpuSet

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<'a> IntoIterator for &'a CpuSet

type Item = &'a CpuLocation

The type of the elements being iterated over.

type IntoIter = Iter<'a, CpuLocation>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a, CpuLocation>

Creates an iterator from a value.

impl IntoIterator for CpuSet

type Item = CpuLocation

The type of the elements being iterated over.

type IntoIter = IntoIter<CpuLocation>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter<CpuLocation>

Creates an iterator from a value.

impl PartialEq for CpuSet

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CpuSet