Skip to content

add Mint.HTTP.module/1 to describe the conn module given a conn #324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ericmj merged 6 commits into from
Sep 12, 2021
Merged

add Mint.HTTP.module/1 to describe the conn module given a conn #324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
164f82f
add Mint.HTTP.module/1 to describe the conn module given a conn
andyleclair Jul 21, 2021
bd6dfaa
return protocol as http1 or http2
andyleclair Sep 1, 2021
e295cf4
fix docstring
andyleclair Sep 1, 2021
5193fe4
remove unsafe proxy
andyleclair Sep 1, 2021
84908f8
clean up docs, add support for unsafeproxy, doctest protocol/1
andyleclair Sep 2, 2021
4b139ee
only use @doc since: in supported versions
andyleclair Sep 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions lib/mint/http.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,26 @@ defmodule Mint.HTTP do
def upgrade(old_transport, transport_state, scheme, hostname, port, opts),
do: Mint.Negotiate.upgrade(old_transport, transport_state, scheme, hostname, port, opts)

@doc """
Returns the protocol used by the current connection.

## Examples

iex> Mint.HTTP.protocol(%Mint.HTTP1{})
:http1

iex> Mint.HTTP.protocol(%Mint.HTTP2{})
:http2
"""
if Version.compare(System.version(), "1.7.0") in [:eq, :gt] do
@doc since: "1.4.0"
end

@spec protocol(t()) :: :http1 | :http2
def protocol(%Mint.HTTP1{}), do: :http1
def protocol(%Mint.HTTP2{}), do: :http2
def protocol(%Mint.UnsafeProxy{state: internal_conn}), do: protocol(internal_conn)

@doc false
@impl true
@spec initiate(
Expand Down
4 changes: 4 additions & 0 deletions test/http_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
defmodule Mint.HTTPTest do
use ExUnit.Case, async: true
doctest Mint.HTTP
end