Struct thread_priority::ThreadBuilder
source · [−]pub struct ThreadBuilder { /* private fields */ }
Expand description
A copy of the std::thread::Builder
builder allowing to set priority settings.
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();
Implementations
Names the thread-to-be. Currently the name is used for identification only in panic messages.
The name must not contain null bytes (\0
).
For more information about named threads, see
std::thread::Builder::name()
.
Sets the size of the stack (in bytes) for the new thread.
The actual stack size may be greater than this value if the platform specifies a minimal stack size.
For more information about the stack size for threads, see
std::thread::Builder::stack_size()
.
The thread’s custom priority.
For more information about the stack size for threads, see
ThreadPriority
.
The WinAPI priority representation.
For more information, see
crate::windows::WinAPIThreadPriority
.
Disables or enables the ability of the system to temporarily boost the priority of a thread.
For more information, see
crate::windows::set_thread_priority_boost
.
Sets a preferred processor for a thread. The system schedules threads on their preferred processors whenever possible.
For more information, see
crate::windows::set_thread_ideal_processor
.
Spawns a new thread by taking ownership of the Builder
, and returns an
std::io::Result
to its std::thread::JoinHandle
.
pub fn spawn_careless<F, T>(self, f: F) -> Result<JoinHandle<T>> where
F: FnOnce() -> T,
F: Send + 'static,
T: Send + 'static,
pub fn spawn_careless<F, T>(self, f: F) -> Result<JoinHandle<T>> where
F: FnOnce() -> T,
F: Send + 'static,
T: Send + 'static,
Spawns a new thread by taking ownership of the Builder
, and returns an
std::io::Result
to its std::thread::JoinHandle
.
Trait Implementations
Returns the “default value” for a type. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Auto Trait Implementations
impl RefUnwindSafe for ThreadBuilder
impl Send for ThreadBuilder
impl Sync for ThreadBuilder
impl Unpin for ThreadBuilder
impl UnwindSafe for ThreadBuilder
Blanket Implementations
Mutably borrows from an owned value. Read more