     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
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68

    //! Support for concurrent and parallel programming.
    //!
    //! This crate is an early work in progress. The focus for the moment is
    //! concurrency:
    //!
    //! - **Non-blocking data structures**. These data structures allow for high
    //! performance, highly-concurrent access, much superior to wrapping with a
    //! `Mutex`. Ultimately the goal is to include stacks, queues, deques, bags,
    //! sets and maps. These live in the `sync` module.
    //!
    //! - **Memory management**. Because non-blocking data structures avoid global
    //! synchronization, it is not easy to tell when internal data can be safely
    //! freed. The `mem` module provides generic, easy to use, and high-performance
    //! APIs for managing memory in these cases. These live in the `mem` module.
    //!
    //! - **Synchronization**. The standard library provides a few synchronization
    //! primitives (locks, barriers, etc) but this crate seeks to expand that set
    //! to include more advanced/niche primitives, as well as userspace
    //! alternatives. These live in the `sync` module.
    //!
    //! - **Scoped thread API**. Finally, the crate provides a "scoped" thread API,
    //! making it possible to spawn threads that share stack data with their
    //! parents. This functionality is exported at the top-level.

    //#![deny(missing_docs)]

    #![cfg_attr(feature = "nightly",
                feature(const_fn, repr_simd, optin_builtin_traits))]

    use std::thread;
    use std::io;

    pub use scoped::{scope, Scope, ScopedJoinHandle};

    pub mod epoch;
    pub mod sync;
    mod scoped;

    mod cache_padded;
    pub use self::cache_padded::{CachePadded, ZerosValid};

    #[doc(hidden)]
    trait FnBox {
        fn call_box(self: Box<Self>);
    }

    impl<F: FnOnce()> FnBox for F {
        fn call_box(self: Box<Self>) { (*self)() }
    }

    /// Like `std::thread::spawn`, but without the closure bounds.
    pub unsafe fn spawn_unsafe<'a, F>(f: F) -> thread::JoinHandle<()> where F: FnOnce() + Send + 'a {
        let builder = thread::Builder::new();
        builder_spawn_unsafe(builder, f).unwrap()
    }

    /// Like `std::thread::Builder::spawn`, but without the closure bounds.
    pub unsafe fn builder_spawn_unsafe<'a, F>(builder: thread::Builder, f: F)
            -> io::Result<thread::JoinHandle<()>>
        where F: FnOnce() + Send + 'a
    {
        use std::mem;

        let closure: Box<FnBox + 'a> = Box::new(f);
        let closure: Box<FnBox + Send> = mem::transmute(closure);
        builder.spawn(move || closure.call_box())
    }

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