      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

    use std::io;

    use futures::{Async, Poll};
    use http2;

    use super::{helpers, HttpHandlerTask, Writer};
    use http::{StatusCode, Version};
    use Error;

    /// Errors produced by `AcceptorError` service.
    #[derive(Debug)]
    pub enum AcceptorError<T> {
        /// The inner service error
        Service(T),

        /// Io specific error
        Io(io::Error),

        /// The request did not complete within the specified timeout.
        Timeout,
    }

    #[derive(Fail, Debug)]
    /// A set of errors that can occur during dispatching http requests
    pub enum HttpDispatchError {
        /// Application error
        #[fail(display = "Application specific error: {}", _0)]
        App(Error),

        /// An `io::Error` that occurred while trying to read or write to a network
        /// stream.
        #[fail(display = "IO error: {}", _0)]
        Io(io::Error),

        /// The first request did not complete within the specified timeout.
        #[fail(display = "The first request did not complete within the specified timeout")]
        SlowRequestTimeout,

        /// Shutdown timeout
        #[fail(display = "Connection shutdown timeout")]
        ShutdownTimeout,

        /// HTTP2 error
        #[fail(display = "HTTP2 error: {}", _0)]
        Http2(http2::Error),

        /// Payload is not consumed
        #[fail(display = "Task is completed but request's payload is not consumed")]
        PayloadIsNotConsumed,

        /// Malformed request
        #[fail(display = "Malformed request")]
        MalformedRequest,

        /// Internal error
        #[fail(display = "Internal error")]
        InternalError,

        /// Unknown error
        #[fail(display = "Unknown error")]
        Unknown,
    }

    impl From<Error> for HttpDispatchError {
        fn from(err: Error) -> Self {
            HttpDispatchError::App(err)
        }
    }

    impl From<io::Error> for HttpDispatchError {
        fn from(err: io::Error) -> Self {
            HttpDispatchError::Io(err)
        }
    }

    impl From<http2::Error> for HttpDispatchError {
        fn from(err: http2::Error) -> Self {
            HttpDispatchError::Http2(err)
        }
    }

    pub(crate) struct ServerError(Version, StatusCode);

    impl ServerError {
        pub fn err(ver: Version, status: StatusCode) -> Box<HttpHandlerTask> {
            Box::new(ServerError(ver, status))
        }
    }

    impl HttpHandlerTask for ServerError {
        fn poll_io(&mut self, io: &mut Writer) -> Poll<bool, Error> {
            {
                let bytes = io.buffer();
                // Buffer should have sufficient capacity for status line
                // and extra space
                bytes.reserve(helpers::STATUS_LINE_BUF_SIZE + 1);
                helpers::write_status_line(self.0, self.1.as_u16(), bytes);
            }
            // Convert Status Code to Reason.
            let reason = self.1.canonical_reason().unwrap_or("");
            io.buffer().extend_from_slice(reason.as_bytes());
            // No response body.
            io.buffer().extend_from_slice(b"\r\ncontent-length: 0\r\n");
            // date header
            io.set_date();
            Ok(Async::Ready(true))
        }
    }

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