      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
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153

    /// Associates readiness notifications with [`Evented`] handles.
    ///
    /// `Token` is a wrapper around `usize` and is used as an argument to
    /// [`Poll::register`] and [`Poll::reregister`].
    ///
    /// See [`Poll`] for more documentation on polling.
    ///
    /// # Example
    ///
    /// Using `Token` to track which socket generated the notification. In this
    /// example, `HashMap` is used, but usually something like [`slab`] is better.
    ///
    /// ```
    /// # use std::error::Error;
    /// # fn try_main() -> Result<(), Box<Error>> {
    /// use mio::{Events, Ready, Poll, PollOpt, Token};
    /// use mio::net::TcpListener;
    ///
    /// use std::thread;
    /// use std::io::{self, Read};
    /// use std::collections::HashMap;
    ///
    /// // After this number of sockets is accepted, the server will shutdown.
    /// const MAX_SOCKETS: usize = 32;
    ///
    /// // Pick a token that will not be used by any other socket and use that one
    /// // for the listener.
    /// const LISTENER: Token = Token(1024);
    ///
    /// // Used to store the sockets.
    /// let mut sockets = HashMap::new();
    ///
    /// // This is used to generate a unique token for a socket
    /// let mut next_socket_index = 0;
    ///
    /// // The `Poll` instance
    /// let poll = Poll::new()?;
    ///
    /// // Tcp listener
    /// let listener = TcpListener::bind(&"127.0.0.1:0".parse()?)?;
    ///
    /// // Register the listener
    /// poll.register(&listener,
    ///               LISTENER,
    ///               Ready::readable(),
    ///               PollOpt::edge())?;
    ///
    /// // Spawn a thread that will connect a bunch of sockets then close them
    /// let addr = listener.local_addr()?;
    /// thread::spawn(move || {
    ///     use std::net::TcpStream;
    ///
    ///     // +1 here is to connect an extra socket to signal the socket to close
    ///     for _ in 0..(MAX_SOCKETS+1) {
    ///         // Connect then drop the socket
    ///         let _ = TcpStream::connect(&addr).unwrap();
    ///     }
    /// });
    ///
    /// // Event storage
    /// let mut events = Events::with_capacity(1024);
    ///
    /// // Read buffer, this will never actually get filled
    /// let mut buf = [0; 256];
    ///
    /// // The main event loop
    /// loop {
    ///     // Wait for events
    ///     poll.poll(&mut events, None)?;
    ///
    ///     for event in &events {
    ///         match event.token() {
    ///             LISTENER => {
    ///                 // Perform operations in a loop until `WouldBlock` is
    ///                 // encountered.
    ///                 loop {
    ///                     match listener.accept() {
    ///                         Ok((socket, _)) => {
    ///                             // Shutdown the server
    ///                             if next_socket_index == MAX_SOCKETS {
    ///                                 return Ok(());
    ///                             }
    ///
    ///                             // Get the token for the socket
    ///                             let token = Token(next_socket_index);
    ///                             next_socket_index += 1;
    ///
    ///                             // Register the new socket w/ poll
    ///                             poll.register(&socket,
    ///                                          token,
    ///                                          Ready::readable(),
    ///                                          PollOpt::edge())?;
    ///
    ///                             // Store the socket
    ///                             sockets.insert(token, socket);
    ///                         }
    ///                         Err(ref e) if e.kind() == io::ErrorKind::WouldBlock => {
    ///                             // Socket is not ready anymore, stop accepting
    ///                             break;
    ///                         }
    ///                         e => panic!("err={:?}", e), // Unexpected error
    ///                     }
    ///                 }
    ///             }
    ///             token => {
    ///                 // Always operate in a loop
    ///                 loop {
    ///                     match sockets.get_mut(&token).unwrap().read(&mut buf) {
    ///                         Ok(0) => {
    ///                             // Socket is closed, remove it from the map
    ///                             sockets.remove(&token);
    ///                             break;
    ///                         }
    ///                         // Data is not actually sent in this example
    ///                         Ok(_) => unreachable!(),
    ///                         Err(ref e) if e.kind() == io::ErrorKind::WouldBlock => {
    ///                             // Socket is not ready anymore, stop reading
    ///                             break;
    ///                         }
    ///                         e => panic!("err={:?}", e), // Unexpected error
    ///                     }
    ///                 }
    ///             }
    ///         }
    ///     }
    /// }
    /// #     Ok(())
    /// # }
    /// #
    /// # fn main() {
    /// #     try_main().unwrap();
    /// # }
    /// ```
    ///
    /// [`Evented`]: event/trait.Evented.html
    /// [`Poll`]: struct.Poll.html
    /// [`Poll::register`]: struct.Poll.html#method.register
    /// [`Poll::reregister`]: struct.Poll.html#method.reregister
    /// [`slab`]: https://crates.io/crates/slab
    #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
    pub struct Token(pub usize);

    impl From<usize> for Token {
        fn from(val: usize) -> Token {
            Token(val)
        }
    }

    impl From<Token> for usize {
        fn from(val: Token) -> usize {
            val.0
        }
    }

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