# response.rs.html -- source
Source to the Rust file `src/client/response.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
     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

    use std::cell::RefCell;
    use std::{fmt, str};

    use cookie::Cookie;
    use http::header::{self, HeaderValue};
    use http::{HeaderMap, StatusCode, Version};

    use error::CookieParseError;
    use httpmessage::HttpMessage;

    use super::pipeline::Pipeline;

    pub(crate) struct ClientMessage {
        pub status: StatusCode,
        pub version: Version,
        pub headers: HeaderMap<HeaderValue>,
        pub cookies: Option<Vec<Cookie<'static>>>,
    }

    impl Default for ClientMessage {
        fn default() -> ClientMessage {
            ClientMessage {
                status: StatusCode::OK,
                version: Version::HTTP_11,
                headers: HeaderMap::with_capacity(16),
                cookies: None,
            }
        }
    }

    /// An HTTP Client response
    pub struct ClientResponse(ClientMessage, RefCell<Option<Box<Pipeline>>>);

    impl HttpMessage for ClientResponse {
        type Stream = Box<Pipeline>;

        /// Get the headers from the response.
        #[inline]
        fn headers(&self) -> &HeaderMap {
            &self.0.headers
        }

        #[inline]
        fn payload(&self) -> Box<Pipeline> {
            self.1
                .borrow_mut()
                .take()
                .expect("Payload is already consumed.")
        }
    }

    impl ClientResponse {
        pub(crate) fn new(msg: ClientMessage) -> ClientResponse {
            ClientResponse(msg, RefCell::new(None))
        }

        pub(crate) fn set_pipeline(&mut self, pl: Box<Pipeline>) {
            *self.1.borrow_mut() = Some(pl);
        }

        /// Get the HTTP version of this response.
        #[inline]
        pub fn version(&self) -> Version {
            self.0.version
        }

        /// Get the status from the server.
        #[inline]
        pub fn status(&self) -> StatusCode {
            self.0.status
        }

        /// Load response cookies.
        pub fn cookies(&self) -> Result<Vec<Cookie<'static>>, CookieParseError> {
            let mut cookies = Vec::new();
            for val in self.0.headers.get_all(header::SET_COOKIE).iter() {
                let s = str::from_utf8(val.as_bytes()).map_err(CookieParseError::from)?;
                cookies.push(Cookie::parse_encoded(s)?.into_owned());
            }
            Ok(cookies)
        }

        /// Return request cookie.
        pub fn cookie(&self, name: &str) -> Option<Cookie> {
            if let Ok(cookies) = self.cookies() {
                for cookie in cookies {
                    if cookie.name() == name {
                        return Some(cookie);
                    }
                }
            }
            None
        }
    }

    impl fmt::Debug for ClientResponse {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            let res = writeln!(f, "\nClientResponse {:?} {}", self.version(), self.status());
            let _ = writeln!(f, "  headers:");
            for (key, val) in self.headers().iter() {
                let _ = writeln!(f, "    {:?}: {:?}", key, val);
            }
            res
        }
    }

    #[cfg(test)]
    mod tests {
        use super::*;

        #[test]
        fn test_debug() {
            let mut resp = ClientResponse::new(ClientMessage::default());
            resp.0
                .headers
                .insert(header::COOKIE, HeaderValue::from_static("cookie1=value1"));
            resp.0
                .headers
                .insert(header::COOKIE, HeaderValue::from_static("cookie2=value2"));

            let dbg = format!("{:?}", resp);
            assert!(dbg.contains("ClientResponse"));
        }
    }

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