thread-priority
A simple library to control thread schedule policies and thread priority.
If your operating system isn't yet supported, please, create an issue.
Minimal Rust Compiler Version
Is 1.46. If you need any help making it possible to compile with 1.36 please reach out.
Supported platforms
- Linux
- DragonFly
- FreeBSD
- OpenBSD
- NetBSD
- macOS
- Windows
Examples
Minimal cross-platform examples
Setting current thread's priority to minimum:
use thread_priority::*;
fn main() {
assert!(set_current_thread_priority(ThreadPriority::Min).is_ok());
}
The same as above but using a specific value:
use thread_priority::*;
use std::convert::TryInto;
fn main() {
// The lower the number the lower the priority.
assert!(set_current_thread_priority(ThreadPriority::Crossplatform(0.try_into().unwrap())).is_ok());
}
Windows-specific examples
Set the thread priority to the lowest possible value:
use thread_priority::*;
fn main() {
// The lower the number the lower the priority.
assert!(set_current_thread_priority(ThreadPriority::Os(WinAPIThreadPriority::Lowest.into())).is_ok());
}
Set the ideal processor for the new thread:
use thread_priority::*;
fn main() {
std::thread::spawn(|| {
set_thread_ideal_processor(thread_native_id(), 0);
println!("Hello world!");
});
}
Building a thread using the ThreadBuilderExt trait
use thread_priority::*;
use thread_priority::ThreadBuilderExt;
let thread = std::thread::Builder::new()
.name("MyNewThread".to_owned())
.spawn_with_priority(ThreadPriority::Max, |result| {
// This is printed out from within the spawned thread.
println!("Set priority result: {:?}", result);
assert!(result.is_ok());
}).unwrap();
thread.join();
Building a thread using the ThreadBuilder.
use thread_priority::*;
let thread = ThreadBuilder::default()
.name("MyThread")
.priority(ThreadPriority::Max)
.spawn(|result| {
// This is printed out from within the spawned thread.
println!("Set priority result: {:?}", result);
assert!(result.is_ok());
}).unwrap();
thread.join();
// Another example where we don't care about the priority having been set.
let thread = ThreadBuilder::default()
.name("MyThread")
.priority(ThreadPriority::Max)
.spawn_careless(|| {
// This is printed out from within the spawned thread.
println!("We don't care about the priority result.");
}).unwrap();
thread.join();
Using ThreadExt trait on the current thread
use thread_priority::*;
assert!(std::thread::current().get_priority().is_ok());
println!("This thread's native id is: {:?}", std::thread::current().get_native_id());
License
This project is licensed under the MIT license.
40 Jan 16, 2023
8 Feb 1, 2023
29 Aug 13, 2023
19 Aug 8, 2023
116 Dec 30, 2022
493 Jan 4, 2023
6 Jul 27, 2022
5 Dec 11, 2023
33 Mar 7, 2023
43 Nov 25, 2022
28 Dec 12, 2022
24 Aug 5, 2022
1 Feb 7, 2022
1 Sep 19, 2022
5 Dec 7, 2022
2 Dec 15, 2022
20 Dec 24, 2022
1 May 25, 2022
7 Jan 2, 2023