std::thread - Rust
Description: API documentation for the Rust `thread` mod in crate `std`.
Keywords: rust, rustlang, rust-lang, thread

# 1.0.0[−][src]Module std::thread

Native threads.

## The threading model

An executing Rust program consists of a collection of native OS threads, each with their own stack and local state. Threads can be named, and provide some built-in support for low-level synchronization.

Communication between threads can be done through channels, Rust's message-passing types, along with other forms of thread synchronization and shared-memory data structures. In particular, types that are guaranteed to be threadsafe are easily shared between threads using the atomically-reference-counted container, `Arc`.

Fatal logic errors in Rust cause thread panic, during which a thread will unwind the stack, running destructors and freeing owned resources. While not meant as a 'try/catch' mechanism, panics in Rust can nonetheless be caught (unless compiling with `panic=abort`) with `catch_unwind` and recovered from, or alternatively be resumed with `resume_unwind`. If the panic is not caught the thread will exit, but the panic may optionally be detected from a different thread with `join`. If the main thread panics without the panic being caught, the application will exit with a non-zero exit code.

When the main thread of a Rust program terminates, the entire program shuts down, even if other threads are still running. However, this module provides convenient facilities for automatically waiting for the termination of a child thread (i.e., join).

## Spawning a thread

A new thread can be spawned using the `thread::spawn` function:

    use std::thread;

    thread::spawn(move || {
        // some work here
    });Run

In this example, the spawned thread is "detached" from the current thread. This means that it can outlive its parent (the thread that spawned it), unless this parent is the main thread.

The parent thread can also wait on the completion of the child thread; a call to `spawn` produces a `JoinHandle`, which provides a `join` method for waiting:

    use std::thread;

    let child = thread::spawn(move || {
        // some work here
    });
    // some work here
    let res = child.join();Run

The `join` method returns a `thread::Result` containing `Ok` of the final value produced by the child thread, or `Err` of the value given to a call to `panic!` if the child panicked.

## Configuring threads

A new thread can be configured before it is spawned via the `Builder` type, which currently allows you to set the name and stack size for the child thread:

    use std::thread;

    thread::Builder::new().name("child1".to_string()).spawn(move || {
        println!("Hello, world!");
    });Run

## The `Thread` type

Threads are represented via the `Thread` type, which you can get in one of two ways:

- By spawning a new thread, e.g., using the `thread::spawn` function, and calling `thread` on the `JoinHandle`.
- By requesting the current thread, using the `thread::current` function.

The `thread::current` function is available even for threads not spawned by the APIs of this module.

## Thread-local storage

This module also provides an implementation of thread-local storage for Rust programs. Thread-local storage is a method of storing data into a global variable that each thread in the program will have its own copy of. Threads do not share this data, so accesses do not need to be synchronized.

A thread-local key owns the value it contains and will destroy the value when the thread exits. It is created with the `thread_local!` macro and can contain any value that is `'static` (no borrowed pointers). It provides an accessor function, `with`, that yields a shared reference to the value to the specified closure. Thread-local keys allow only shared access to values, as there would be no way to guarantee uniqueness if mutable borrows were allowed. Most values will want to make use of some form of interior mutability through the `Cell` or `RefCell` types.

## Naming threads

Threads are able to have associated names for identification purposes. By default, spawned threads are unnamed. To specify a name for a thread, build the thread with `Builder` and pass the desired thread name to `Builder::name`. To retrieve the thread name from within the thread, use `Thread::name`. A couple examples of where the name of a thread gets used:

- If a panic occurs in a named thread, the thread name will be printed in the panic message.
- The thread name is provided to the OS where applicable (e.g., `pthread_setname_np` in unix-like platforms).

## Stack size

The default stack size for spawned threads is 2 MiB, though this particular stack size is subject to change in the future. There are two ways to manually specify the stack size for spawned threads:

- Build the thread with `Builder` and pass the desired stack size to `Builder::stack_size`.
- Set the `RUST_MIN_STACK` environment variable to an integer representing the desired stack size (in bytes). Note that setting `Builder::stack_size` will override this.

Note that the stack size of the main thread is not determined by Rust.

## Structs

AccessError | An error returned by `LocalKey::try_with`.
Builder | Thread factory, which can be used in order to configure the properties of a new thread.
JoinHandle | An owned permission to join on a thread (block on its termination).
LocalKey | A thread local storage key which owns its contents.
Thread | A handle to a thread.
ThreadId | A unique identifier for a running thread.

## Functions

current | Gets a handle to the thread that invokes it.
panicking | Determines whether the current thread is unwinding because of panic.
park | Blocks unless or until the current thread's token is made available.
park_timeout | Blocks unless or until the current thread's token is made available or the specified duration has been reached (may wake spuriously).
park_timeout_ms | Deprecated Use `park_timeout`.
sleep | Puts the current thread to sleep for at least the specified amount of time.
sleep_ms | Deprecated Puts the current thread to sleep for at least the specified amount of time.
spawn | Spawns a new thread, returning a `JoinHandle` for it.
yield_now | Cooperatively gives up a timeslice to the OS scheduler.

## Type Definitions

Result | A specialized `Result` type for threads.

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)