Struct crossbeam_utils::thread::ScopedThreadBuilder

pub struct ScopedThreadBuilder<'scope, 'env> { /* private fields */ }

Configures the properties of a new thread.

The two configurable properties are:

• name: Specifies an associated name for the thread.
• stack_size: Specifies the desired stack size for the thread.

The spawn method will take ownership of the builder and return an io::Result of the thread handle with the given configuration.

The Scope::spawn method uses a builder with default configuration and unwraps its return value. You may want to use this builder when you want to recover from a failure to launch a thread.

Examples

use crossbeam_utils::thread;

thread::scope(|s| {
    s.builder()
        .spawn(|_| println!("Running a child thread"))
        .unwrap();
}).unwrap();

Implementations

impl<'scope, 'env> ScopedThreadBuilder<'scope, 'env>

pub fn name(self, name: String) -> ScopedThreadBuilder<'scope, 'env>

Sets the name for the new thread.

The name must not contain null bytes (\0).

For more information about named threads, see here.

Examples

use crossbeam_utils::thread;
use std::thread::current;

thread::scope(|s| {
    s.builder()
        .name("my thread".to_string())
        .spawn(|_| assert_eq!(current().name(), Some("my thread")))
        .unwrap();
}).unwrap();

pub fn stack_size(self, size: usize) -> ScopedThreadBuilder<'scope, 'env>

Sets the size of the stack for the new thread.

The stack size is measured in bytes.

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

Examples

use crossbeam_utils::thread;

thread::scope(|s| {
    s.builder()
        .stack_size(32 * 1024)
        .spawn(|_| println!("Running a child thread"))
        .unwrap();
}).unwrap();

pub fn spawn<F, T>(self, f: F) -> Result<ScopedJoinHandle<'scope, T>> where
    F: FnOnce(&Scope<'env>) -> T,
    F: Send + 'env,
    T: Send + 'env, 

Spawns a scoped thread with this configuration.

The scoped thread is passed a reference to this scope as an argument, which can be used for spawning nested threads.

The returned handle can be used to manually join the thread before the scope exits.

Errors

Unlike the Scope::spawn method, this method yields an io::Result to capture any failure to create the thread at the OS level.

Panics

Panics if a thread name was set and it contained null bytes.

Examples

use crossbeam_utils::thread;

thread::scope(|s| {
    let handle = s.builder()
        .spawn(|_| {
            println!("A child thread is running");
            42
        })
        .unwrap();

    // Join the thread and retrieve its result.
    let res = handle.join().unwrap();
    assert_eq!(res, 42);
}).unwrap();

Trait Implementations

impl<'scope, 'env> Debug for ScopedThreadBuilder<'scope, 'env>

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

Formats the value using the given formatter.