@type headers() :: %{optional(binary()) => [binary()]}

Headers sent with a request or returned in a response from the server.

Maps response header names (all lowercase, like "content-encoding") to the values associated with that header. This is structured as a map, the way the Req library does, to make it clear that servers may legitimately send multiple values for the same header name.

You can use BrowseyHttp.Response.headers_to_proplist/1 to convert this to the format used by HTTP clients like Finch or HTTPoison, and you can use BrowseyHttp.Response.proplist_to_headers/1 to convert from that format to this one.

@type t() :: %BrowseyHttp.Response{
  body: binary(),
  final_uri: URI.t(),
  headers: headers(),
  runtime_ms: timeout(),
  status: non_neg_integer(),
  uri_sequence: [URI.t(), ...]
}

Fields on a response:

• :body: the response body. For HTML documents, this will always be a String.t(), but for binary files like images and videos, it will be non-Unicode binary data.
• :headers: a map from response header names (all lowercase, like "content-encoding") to the values associated with that header. This is structured as a map, the way the Req library does, to make it clear that servers may legitimately send multiple values for the same header name.
• :status: the HTTP status code returned by the final URL in the chain of redirects, like 200 or 404.
• :final_uri: the final URL in the chain of redirects, as a URI.
• :uri_sequence: the complete chain of URLs that were visited (length 1 if there were no redirects), as a list of URIs. The first element will always be URL that was passed to BrowseyHttp.get/2, and the last will always be the :final_uri.
• :runtime_ms: the number of milliseconds the request took to complete, including all redirects.