Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iddm/thread-priority
A simple Cross-platform thread schedule and priority library for rust.
https://github.com/iddm/thread-priority
priority pthread rust rust-library schedule thread
Last synced: 4 days ago
JSON representation
A simple Cross-platform thread schedule and priority library for rust.
- Host: GitHub
- URL: https://github.com/iddm/thread-priority
- Owner: iddm
- License: mit
- Created: 2017-06-22T10:47:33.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-11-07T09:25:20.000Z (2 months ago)
- Last Synced: 2024-11-16T11:32:29.339Z (about 2 months ago)
- Topics: priority, pthread, rust, rust-library, schedule, thread
- Language: Rust
- Homepage:
- Size: 151 KB
- Stars: 110
- Watchers: 1
- Forks: 20
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-rust - iddm/thread-priority - Simple, crossplatform thread priority management. [](https://github.com/iddm/thread-priority/actions/workflows/ci.yml) [](https://crates.io/crates/thread-priority) (Libraries / Platform specific)
README
# thread-priority
[](https://github.com/iddm/thread-priority/actions/workflows/ci.yml) [](https://crates.io/crates/thread-priority) [](https://docs.rs/thread-priority) [](./LICENSE)
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.67`. If you need any help making it possible to compile with `1.56` please reach out, it
should be possible by just downgrading the `rstest` version to `0.17` or lower (the code is
compatible).
## Supported platforms
- Linux
- Android
- DragonFly
- FreeBSD
- OpenBSD
- NetBSD
- macOS
- iOS
- Windows
## Examples
### Minimal cross-platform examples
Setting current thread's priority to minimum:
```rust,no_run
use thread_priority::*;
fn main() {
assert!(set_current_thread_priority(ThreadPriority::Min).is_ok());
}
```
The same as above but using a specific value:
```rust,no_run
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:
```rust,no_run
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:
```rust,no_run
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
```rust,no_run
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.
```rust,no_run
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
```rust,no_run
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](https://github.com/iddm/thread-priority/blob/master/LICENSE).