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

# Struct std::thread::Thread 1.0.0 [−] [src]

    pub struct Thread { /* fields omitted */ }

A handle to a thread.

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`][`JoinHandle::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.

There is usualy no need to create a `Thread` struct yourself, one should instead use a function like `spawn` to create new threads, see the docs of `Builder` and `spawn` for more details.

## Methods

### `impl Thread`
[src]

#### `fn unpark(&self)`

Atomically makes the handle's token available if it is not already.

Every thread is equipped with some basic low-level blocking support, via the `park` function and the `unpark()` method. These can be used as a more CPU-efficient implementation of a spinlock.

See the park documentation for more details.

# Examples

    use std::thread;
    use std::time::Duration;

    let parked_thread = thread::Builder::new()
        .spawn(|| {
            println!("Parking thread");
            thread::park();
            println!("Thread unparked");
        })
        .unwrap();

    // Let some time pass for the thread to be spawned.
    thread::sleep(Duration::from_millis(10));

    println!("Unpark the thread");
    parked_thread.thread().unpark();

    parked_thread.join().unwrap();Run

#### `fn id(&self) -> ThreadId`
1.19.0

Gets the thread's unique identifier.

# Examples

    use std::thread;

    let other_thread = thread::spawn(|| {
        thread::current().id()
    });

    let other_thread_id = other_thread.join().unwrap();
    assert!(thread::current().id() != other_thread_id);Run

#### `fn name(&self) -> Option<&str>`

Gets the thread's name.

# Examples

Threads by default have no name specified:

    use std::thread;

    let builder = thread::Builder::new();

    let handler = builder.spawn(|| {
        assert!(thread::current().name().is_none());
    }).unwrap();

    handler.join().unwrap();Run

Thread with a specified name:

    use std::thread;

    let builder = thread::Builder::new()
        .name("foo".into());

    let handler = builder.spawn(|| {
        assert_eq!(thread::current().name(), Some("foo"))
    }).unwrap();

    handler.join().unwrap();Run

## Trait Implementations

### `impl Clone for Thread`
[src]

#### `fn clone(&self) -> Thread`

Returns a copy of the value. Read more

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

Performs copy-assignment from `source`. Read more

### `impl Debug for Thread`
[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`

Formats the value using the given formatter.

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand 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`)