Struct ThreadBuilder

pub struct ThreadBuilder { /* private fields */ }

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();

If the compiler version is at least 1.63, the scoped thread support is also enabled.

use thread_priority::*;

// Scoped thread is also supported if the compiler version is at least 1.63.
let mut x = 0;
std::thread::scope(|s|{
    let thread = ThreadBuilder::default()
        .name("MyThread")
        .priority(ThreadPriority::Max)
        .spawn_scoped(s, |result| {
            // This is printed out from within the spawned thread.
            println!("Set priority result: {:?}", result);
            assert!(result.is_ok());
            x += 1;
    }).unwrap();
    thread.join();
});
assert_eq!(x, 1);

// Scoped thread also has a "careless" mode.
std::thread::scope(|s|{
    let thread = ThreadBuilder::default()
        .name("MyThread")
        .priority(ThreadPriority::Max)
        .spawn_scoped_careless(s, || {
            // This is printed out from within the spawned thread.
            println!("We don't care about the priority result.");
            x += 1;
    }).unwrap();
    thread.join();
});
assert_eq!(x, 2);

Implementations

impl ThreadBuilder

pub fn name<VALUE: Into<String>>(self, value: VALUE) -> Self

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().

pub fn stack_size<VALUE: Into<usize>>(self, value: VALUE) -> Self

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().

pub fn priority<VALUE: Into<ThreadPriority>>(self, value: VALUE) -> Self

The thread’s custom priority.

For more information about the stack size for threads, see ThreadPriority.

pub fn winapi_priority<VALUE: Into<WinAPIThreadPriority>>( self, value: VALUE, ) -> Self

The WinAPI priority representation.

For more information, see crate::windows::WinAPIThreadPriority.

pub fn boost_enabled(self, value: bool) -> Self

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.

pub fn ideal_processor<VALUE: Into<IdealProcessor>>(self, value: VALUE) -> Self

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.

pub fn spawn<F, T>(self, f: F) -> Result<JoinHandle<T>>

where F: FnOnce(Result<(), Error>) -> T + 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.

See std::thread::Builder::spawn

pub fn spawn_scoped<'scope, 'env, F, T>( self, scope: &'scope Scope<'scope, 'env>, f: F, ) -> Result<ScopedJoinHandle<'scope, T>>

where F: FnOnce(Result<(), Error>) -> T + Send + 'scope, T: Send + 'scope,

Spawns a new scoped thread by taking ownership of the Builder, and returns an std::io::Result to its std::thread::ScopedJoinHandle.

See std::thread::Builder::spawn_scoped

pub fn spawn_careless<F, T>(self, f: F) -> Result<JoinHandle<T>>

where F: FnOnce() -> T + 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.

See std::thread::Builder::spawn

pub fn spawn_scoped_careless<'scope, 'env, F, T>( self, scope: &'scope Scope<'scope, 'env>, f: F, ) -> Result<ScopedJoinHandle<'scope, T>>

where F: FnOnce() -> T + Send + 'scope, T: Send + 'scope,

Spawns a new scoped thread by taking ownership of the Builder, and returns an std::io::Result to its std::thread::ScopedJoinHandle.

See std::thread::Builder::spawn_scoped

Trait Implementations

impl Clone for ThreadBuilder

fn clone(&self) -> ThreadBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ThreadBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ThreadBuilder

fn default() -> ThreadBuilder

Returns the “default value” for a type.

impl Hash for ThreadBuilder

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 Ord for ThreadBuilder

fn cmp(&self, other: &ThreadBuilder) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ThreadBuilder

fn eq(&self, other: &ThreadBuilder) -> 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 PartialOrd for ThreadBuilder

fn partial_cmp(&self, other: &ThreadBuilder) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ThreadBuilder

impl StructuralPartialEq for ThreadBuilder