Packages

tesla

1.14.0
1.20.0 1.18.3 1.18.2 1.18.1 1.18.0 1.17.0 1.16.0 1.15.3 1.15.2 1.15.1 1.15.0 1.14.3 1.14.2 1.14.1 1.14.0 1.13.2 1.13.1 1.13.0 1.12.3 1.12.2 1.12.1 1.12.0 1.11.2 1.11.1 1.11.0 1.10.3 1.10.2 1.10.1 1.10.0 1.9.0 1.8.1 retired 1.8.0 1.7.0 1.6.1 1.6.0 1.5.1 1.5.0 1.4.4 1.4.3 1.4.2 1.4.1 1.4.0 1.3.3 1.3.2 1.3.1 1.3.0 1.2.1 1.2.0 1.1.0 1.0.0 1.0.0-beta.1 0.10.0 0.9.0 0.8.0 0.7.2 0.7.1 0.7.0 0.6.0 0.5.2 0.5.1 0.5.0 0.3.6 0.3.5 0.3.4 0.3.3 0.3.2 0.3.1 0.2.2 0.2.1 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0

HTTP client library, with support for middleware and multiple adapters.

Security advisory: This version has known vulnerabilities. View advisories
HexDocs

Current section

Files

Jump to
Readme
75 Versions
14 Dependencies
512 Dependants
5 Advisories
Files
Activity
tesla lib tesla env.ex
Raw

lib/tesla/env.ex 

defmodule Tesla.Env do

  @moduledoc """

  This module defines a `t:Tesla.Env.t/0` struct that stores all data related to request/response.



  ## Fields



  - `:method` - method of request. Example: `:get`

  - `:url` - request url. Example: `"https://www.google.com"`

  - `:query` - list of query params.

    Example: `[{"param", "value"}]` will be translated to `?params=value`.

    Note: query params passed in url (e.g. `"/get?param=value"`) are not parsed to `query` field.

  - `:headers` - list of request/response headers.

    Example: `[{"content-type", "application/json"}]`.

    Note: request headers are overridden by response headers when adapter is called.

  - `:body` - request/response body.

    Note: request body is overridden by response body when adapter is called.

  - `:status` - response status. Example: `200`

  - `:opts` - list of options. Example: `[adapter: [recv_timeout: 30_000]]`

  """



  @type client :: Tesla.Client.t()

  @type method :: :head | :get | :delete | :trace | :options | :post | :put | :patch

  @type url :: binary

  @type param :: binary | [{binary | atom, param}]

  @type query :: [{binary | atom, param}]

  @type headers :: [{binary, binary}]



  @type body :: any

  @type status :: integer | nil

  @type opts :: keyword



  @type runtime :: {atom, atom, any} | {atom, atom} | {:fn, (t -> t)} | {:fn, (t, stack -> t)}

  @type stack :: [runtime]

  @type result :: {:ok, t()} | {:error, any}



  @type t :: %__MODULE__{

          method: method,

          query: query,

          url: url,

          headers: headers,

          body: body,

          status: status,

          opts: opts,

          __module__: atom,

          __client__: client

        }



  defstruct method: nil,

            url: "",

            query: [],

            headers: [],

            body: nil,

            status: nil,

            opts: [],

            __module__: nil,

            __client__: nil

end