Struct CpuSet 

pub struct CpuSet { /* private fields */ }

A sorted, deduplicated, non-empty set of logical CPUs.

Examples

use tenferro_cpu::{CpuId, CpuSet};

let cpus = CpuSet::new([CpuId::new(3), CpuId::new(1), CpuId::new(3)])?;
assert_eq!(cpus.as_usize_vec(), vec![1, 3]);

Implementations

impl CpuSet

pub fn new(cpus: impl IntoIterator<Item = CpuId>) -> Result<Self, CpuSetError>

Construct a sorted and deduplicated CPU set.

Examples

use tenferro_cpu::{CpuId, CpuSet};

let cpus = CpuSet::new([CpuId::new(2), CpuId::new(0)])?;
assert_eq!(cpus.as_usize_vec(), vec![0, 2]);

Errors

Returns CpuSetError::Empty when the iterator yields no CPUs.

pub fn len(&self) -> usize

Return the number of logical CPUs in this set.

Examples

use tenferro_cpu::{CpuId, CpuSet};

assert_eq!(CpuSet::new([CpuId::new(0), CpuId::new(1)])?.len(), 2);

pub fn is_empty(&self) -> bool

Report whether this set is empty.

A successfully constructed CpuSet is never empty.

Examples

use tenferro_cpu::{CpuId, CpuSet};

assert!(!CpuSet::new([CpuId::new(0)])?.is_empty());

pub fn as_slice(&self) -> &[CpuId]

Return the sorted logical CPU identifiers.

Examples

use tenferro_cpu::{CpuId, CpuSet};

let cpus = CpuSet::new([CpuId::new(4), CpuId::new(2)])?;
assert_eq!(cpus.as_slice(), &[CpuId::new(2), CpuId::new(4)]);

pub fn as_usize_vec(&self) -> Vec<usize>

Copy the sorted logical CPU numbers into a vector.

Examples

use tenferro_cpu::{CpuId, CpuSet};

let cpus = CpuSet::new([CpuId::new(6), CpuId::new(5)])?;
assert_eq!(cpus.as_usize_vec(), vec![5, 6]);

pub fn contains(&self, cpu: CpuId) -> bool

Report whether the logical CPU belongs to this set.

Examples

use tenferro_cpu::{CpuId, CpuSet};

let cpus = CpuSet::new([CpuId::new(1), CpuId::new(3)])?;
assert!(cpus.contains(CpuId::new(3)));

Trait Implementations

impl Clone for CpuSet

fn clone(&self) -> CpuSet

Returns a duplicate 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 Eq for CpuSet

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CpuSet