     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

    //! Types related to futures and asynchrony.

    extern crate qutex;

    mod future_mem_map;
    mod order_lock;
    mod rw_vec;
    mod mem_map;
    mod buffer_sink;
    mod buffer_stream;

    pub use self::order_lock::{OrderLock, ReadGuard, WriteGuard, FutureGuard, FutureReadGuard,
        FutureWriteGuard, OrderGuard};
    pub use self::rw_vec::RwVec;
    pub use self::mem_map::MemMap;
    pub use self::future_mem_map::FutureMemMap;
    pub use self::buffer_sink::{BufferSink, FutureFlush, Inner as BufferSinkInner};
    pub use self::buffer_stream::{BufferStream, FutureFlood, Inner as BufferStreamInner};

    // * TODO: Implement this:
    //
    // pub struct EventListTrigger {
    //     wait_events: EventList,
    //     completion_event: UserEvent,
    //     callback_is_set: bool,
    // }

    // pub struct EventTrigger {
    //     wait_event: Event,
    //     completion_event: UserEvent,
    //     callback_is_set: bool,
    // }

    // impl EventTrigger {
    //     pub fn new(wait_event: Event, completion_event: UserEvent) -> EventTrigger {
    //         EventTrigger {
    //             wait_event: wait_event,
    //             completion_event: completion_event ,
    //             callback_is_set: false,
    //         }
    //     }
    // }

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