HTTPStream (HTTPStream v1.0.0) View Source

Main API interface.

HTTPStream is a tiny tiny library for streaming big big files. It works by wrapping HTTP requests onto a Stream. You can use it with Flow, write it to disk through regular streams and more!

HTTPStream.get(large_image_url)
|> Stream.into(File.stream!("large_image.png"))
|> Stream.run()

The adapter can be configured by setting in your config/config.exs:

config :http_stream, adapter: HTTPStream.Adapter.Mint

At the moment, only two adapters are supported: Mint (default) and HTTPoison.

Link to this section Summary

Types

method()

Functions

delete(url, opts \\ [])

Performs a DELETE request.

get(url, opts \\ [])

Performs a GET request.

head(url, opts \\ [])

Performs a HEAD request.

options(url, opts \\ [])

Performs a OPTIONS request.

patch(url, opts \\ [])

Performs a PATCH request.

post(url, opts \\ [])

Performs a POST request.

put(url, opts \\ [])

Performs a PUT request.

request(method, url, headers \\ [], body \\ "")

Performs an HTTP request.

trace(url, opts \\ [])

Performs a TRACE request.

Link to this section Types

method()

Specs

method() :: String.t()

Link to this section Functions

delete(url, opts \\ [])

Specs

delete(String.t(), keyword()) :: Enumerable.t()

Performs a DELETE request.

Supported options:

:headers (optional) - Keyword list of HTTP headers to add to the request.
:query (optional) - Keyword list of query params to add to the request.

get(url, opts \\ [])

Specs

get(String.t(), keyword()) :: Enumerable.t()

Performs a GET request.

Supported options:

:headers (optional) - Keyword list of HTTP headers to add to the request.
:query (optional) - Keyword list of query params to add to the request.

head(url, opts \\ [])

Specs

head(String.t(), keyword()) :: Enumerable.t()

Performs a HEAD request.

Supported options:

:headers (optional) - Keyword list of HTTP headers to add to the request.
:query (optional) - Keyword list of query params to add to the request.

options(url, opts \\ [])

Specs

options(String.t(), keyword()) :: Enumerable.t()

Performs a OPTIONS request.

Supported options:

:headers (optional) - Keyword list of HTTP headers to add to the request.
:query (optional) - Keyword list of query params to add to the request.

patch(url, opts \\ [])

Specs

patch(String.t(), keyword()) :: Enumerable.t()

Performs a PATCH request.

Supported options:

:headers (optional) - Keyword list of HTTP headers to add to the request.
:params (optional) - Keyword list of query params to add to the request.

post(url, opts \\ [])

Specs

post(String.t(), keyword()) :: Enumerable.t()

Performs a POST request.

Supported options:

:headers (optional) - Keyword list of HTTP headers to add to the request.
:params (optional) - Keyword list of query params to add to the request.

put(url, opts \\ [])

Specs

put(String.t(), keyword()) :: Enumerable.t()

Performs a PUT request.

Supported options:

:headers (optional) - Keyword list of HTTP headers to add to the request.
:params (optional) - Keyword list of query params to add to the request.

request(method, url, headers \\ [], body \\ "")

Specs

request(method(), String.t(), keyword(), binary()) :: Enumerable.t()

Performs an HTTP request.

Supported methods: GET, OPTIONS, HEAD, TRACE, POST, PUT, PATCH and DELETE

trace(url, opts \\ [])

Specs

trace(String.t(), keyword()) :: Enumerable.t()

Performs a TRACE request.

Supported options:

:headers (optional) - Keyword list of HTTP headers to add to the request.
:query (optional) - Keyword list of query params to add to the request.