# httpcodes.rs.html -- source
Source to the Rust file `src/httpcodes.rs`.
Keywords: rust, rustlang, rust-lang

     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

    //! Basic http responses
    #![allow(non_upper_case_globals)]
    use http::StatusCode;
    use httpresponse::{HttpResponse, HttpResponseBuilder};

    macro_rules! STATIC_RESP {
        ($name:ident, $status:expr) => {
            #[allow(non_snake_case, missing_docs)]
            pub fn $name() -> HttpResponseBuilder {
                HttpResponse::build($status)
            }
        };
    }

    impl HttpResponse {
        STATIC_RESP!(Ok, StatusCode::OK);
        STATIC_RESP!(Created, StatusCode::CREATED);
        STATIC_RESP!(Accepted, StatusCode::ACCEPTED);
        STATIC_RESP!(
            NonAuthoritativeInformation,
            StatusCode::NON_AUTHORITATIVE_INFORMATION
        );

        STATIC_RESP!(NoContent, StatusCode::NO_CONTENT);
        STATIC_RESP!(ResetContent, StatusCode::RESET_CONTENT);
        STATIC_RESP!(PartialContent, StatusCode::PARTIAL_CONTENT);
        STATIC_RESP!(MultiStatus, StatusCode::MULTI_STATUS);
        STATIC_RESP!(AlreadyReported, StatusCode::ALREADY_REPORTED);

        STATIC_RESP!(MultipleChoices, StatusCode::MULTIPLE_CHOICES);
        STATIC_RESP!(MovedPermanenty, StatusCode::MOVED_PERMANENTLY);
        STATIC_RESP!(MovedPermanently, StatusCode::MOVED_PERMANENTLY);
        STATIC_RESP!(Found, StatusCode::FOUND);
        STATIC_RESP!(SeeOther, StatusCode::SEE_OTHER);
        STATIC_RESP!(NotModified, StatusCode::NOT_MODIFIED);
        STATIC_RESP!(UseProxy, StatusCode::USE_PROXY);
        STATIC_RESP!(TemporaryRedirect, StatusCode::TEMPORARY_REDIRECT);
        STATIC_RESP!(PermanentRedirect, StatusCode::PERMANENT_REDIRECT);

        STATIC_RESP!(BadRequest, StatusCode::BAD_REQUEST);
        STATIC_RESP!(NotFound, StatusCode::NOT_FOUND);
        STATIC_RESP!(Unauthorized, StatusCode::UNAUTHORIZED);
        STATIC_RESP!(PaymentRequired, StatusCode::PAYMENT_REQUIRED);
        STATIC_RESP!(Forbidden, StatusCode::FORBIDDEN);
        STATIC_RESP!(MethodNotAllowed, StatusCode::METHOD_NOT_ALLOWED);
        STATIC_RESP!(NotAcceptable, StatusCode::NOT_ACCEPTABLE);
        STATIC_RESP!(
            ProxyAuthenticationRequired,
            StatusCode::PROXY_AUTHENTICATION_REQUIRED
        );
        STATIC_RESP!(RequestTimeout, StatusCode::REQUEST_TIMEOUT);
        STATIC_RESP!(Conflict, StatusCode::CONFLICT);
        STATIC_RESP!(Gone, StatusCode::GONE);
        STATIC_RESP!(LengthRequired, StatusCode::LENGTH_REQUIRED);
        STATIC_RESP!(PreconditionFailed, StatusCode::PRECONDITION_FAILED);
        STATIC_RESP!(PayloadTooLarge, StatusCode::PAYLOAD_TOO_LARGE);
        STATIC_RESP!(UriTooLong, StatusCode::URI_TOO_LONG);
        STATIC_RESP!(UnsupportedMediaType, StatusCode::UNSUPPORTED_MEDIA_TYPE);
        STATIC_RESP!(RangeNotSatisfiable, StatusCode::RANGE_NOT_SATISFIABLE);
        STATIC_RESP!(ExpectationFailed, StatusCode::EXPECTATION_FAILED);

        STATIC_RESP!(InternalServerError, StatusCode::INTERNAL_SERVER_ERROR);
        STATIC_RESP!(NotImplemented, StatusCode::NOT_IMPLEMENTED);
        STATIC_RESP!(BadGateway, StatusCode::BAD_GATEWAY);
        STATIC_RESP!(ServiceUnavailable, StatusCode::SERVICE_UNAVAILABLE);
        STATIC_RESP!(GatewayTimeout, StatusCode::GATEWAY_TIMEOUT);
        STATIC_RESP!(VersionNotSupported, StatusCode::HTTP_VERSION_NOT_SUPPORTED);
        STATIC_RESP!(VariantAlsoNegotiates, StatusCode::VARIANT_ALSO_NEGOTIATES);
        STATIC_RESP!(InsufficientStorage, StatusCode::INSUFFICIENT_STORAGE);
        STATIC_RESP!(LoopDetected, StatusCode::LOOP_DETECTED);
    }

    #[cfg(test)]
    mod tests {
        use body::Body;
        use http::StatusCode;
        use httpresponse::HttpResponse;

        #[test]
        fn test_build() {
            let resp = HttpResponse::Ok().body(Body::Empty);
            assert_eq!(resp.status(), StatusCode::OK);
        }
    }

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