     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17

    //! A collection of locking data structures, both thread-safe and
    //! single-thread-optimized, which use Rust futures instead of
    //! thread-blocking.
    //!
    //! [![](https://img.shields.io/badge/github-qutex-blue.svg)][repo] [![](http://meritbadge.herokuapp.com/qutex)](https://crates.io/crates/qutex)
    //!
    //! [repo]: https://github.com/cogciprocate/qutex

    extern crate crossbeam;
    extern crate futures;

    mod qutex;
    mod qrw_lock;

    pub use self::qutex::{Guard, FutureGuard, Request, Qutex};
    pub use self::qrw_lock::{ReadGuard, WriteGuard, FutureReadGuard, FutureWriteGuard,
    	QrwRequest, RequestKind, QrwLock};

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