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.

# Examples

    use std::thread;

    let handler = thread::Builder::new()
        .name("foo".into())
        .spawn(|| {
            let thread = thread::current();
            println!("thread name: {}", thread.name().unwrap());
        })
        .unwrap();

    handler.join().unwrap();Run

## Methods

### `impl Thread`
[src]

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

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

See the module doc for more detail.

# Examples

    use std::thread;

    let handler = thread::Builder::new()
        .spawn(|| {
            let thread = thread::current();
            thread.unpark();
        })
        .unwrap();

    handler.join().unwrap();Run

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

🔬 This is a nightly-only experimental API. (`thread_id` #21507)

Gets the thread's unique identifier.

# Examples

    #![feature(thread_id)]

    use std::thread;

    let handler = thread::Builder::new()
        .spawn(|| {
            let thread = thread::current();
            println!("thread id: {:?}", thread.id());
        })
        .unwrap();

    handler.join().unwrap();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`)