     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51

    // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    //! Unix-specific extensions to primitives in the `std::thread` module.

    #![stable(feature = "thread_extensions", since = "1.9.0")]

    #[allow(deprecated)]
    use os::unix::raw::pthread_t;
    use sys_common::{AsInner, IntoInner};
    use thread::JoinHandle;

    #[stable(feature = "thread_extensions", since = "1.9.0")]
    #[allow(deprecated)]
    pub type RawPthread = pthread_t;

    /// Unix-specific extensions to [`thread::JoinHandle`].
    ///
    /// [`thread::JoinHandle`]: ../../../../std/thread/struct.JoinHandle.html
    #[stable(feature = "thread_extensions", since = "1.9.0")]
    pub trait JoinHandleExt {
        /// Extracts the raw pthread_t without taking ownership
        #[stable(feature = "thread_extensions", since = "1.9.0")]
        fn as_pthread_t(&self) -> RawPthread;

        /// Consumes the thread, returning the raw pthread_t
        ///
        /// This function **transfers ownership** of the underlying pthread_t to
        /// the caller. Callers are then the unique owners of the pthread_t and
        /// must either detach or join the pthread_t once it's no longer needed.
        #[stable(feature = "thread_extensions", since = "1.9.0")]
        fn into_pthread_t(self) -> RawPthread;
    }

    #[stable(feature = "thread_extensions", since = "1.9.0")]
    impl<T> JoinHandleExt for JoinHandle<T> {
        fn as_pthread_t(&self) -> RawPthread {
            self.as_inner().id() as RawPthread
        }

        fn into_pthread_t(self) -> RawPthread {
            self.into_inner().into_id() as RawPthread
        }
    }

# 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`)