num_cpus

• Documentation
• CHANGELOG

Count the number of CPUs on the current machine.

Usage

Add to Cargo.toml:

[dependencies]
num_cpus = "1.0"

In your main.rs or lib.rs:

extern crate num_cpus;

// count logical cores this process could try to use
let num = num_cpus::get();

lib.rs:

A crate with utilities to determine the number of CPUs available on the current system.

Sometimes the CPU will exaggerate the number of CPUs it contains, because it can use processor tricks to deliver increased performance when there are more threads. This crate provides methods to get both the logical and physical numbers of cores.

This information can be used as a guide to how many tasks can be run in parallel. There are many properties of the system architecture that will affect parallelism, for example memory access speeds (for all the caches and RAM) and the physical architecture of the processor, so the number of CPUs should be used as a rough guide only.

Examples

Fetch the number of logical CPUs.

let cpus = num_cpus::get();

See rayon::Threadpool for an example of where the number of CPUs could be used when setting up parallel jobs (Where the threadpool example uses a fixed number 8, it could use the number of CPUs).