mojito v0.7.12
mojito

Mojito.Base behaviour (mojito v0.7.12) View Source

Provides a default implementation for Mojito functions.

This module is meant to be use'd in custom modules in order to wrap the functionalities provided by Mojiti. For example, this is very useful to build custom API clients around Mojito:

defmodule CustomAPI do
  use Mojito.Base
end

Link to this section Summary

Types

body()
error()
header()
headers()
method()
payload()
pool_opt()
pool_opts()
request()
request_field()
request_kwlist()
response()
url()

Callbacks

delete(url)
delete(url, headers)
delete(url, headers, t)
get(url)
get(url, headers)
get(url, headers, t)
head(url)
head(url, headers)
head(url, headers, t)
options(url)
options(url, headers)
options(url, headers, t)
patch(url)
patch(url, headers)
patch(url, headers, payload)
patch(url, headers, payload, t)
post(url)
post(url, headers)
post(url, headers, payload)
post(url, headers, payload, t)
put(url)
put(url, headers)
put(url, headers, payload)
put(url, headers, payload, t)
request(arg1)
request(method, url)
request(method, url, headers)
request(method, url, headers, body)
request(method, url, headers, body, t)

Link to this section Types

Link to this type

body()

View Source

Specs

body() :: String.t()
Link to this type

error()

View Source

Specs

error() :: %Mojito.Error{message: String.t() | nil, reason: any()}
Link to this type

header()

View Source

Specs

header() :: {String.t(), String.t()}
Link to this type

headers()

View Source

Specs

headers() :: [header()]
Link to this type

method()

View Source

Specs

method() ::
  :head | :get | :post | :put | :patch | :delete | :options | String.t()
Link to this type

payload()

View Source

Specs

payload() :: String.t()
Link to this type

pool_opt()

View Source

Specs

pool_opt() ::
  {:size, pos_integer()}
  | {:max_overflow, non_neg_integer()}
  | {:pools, pos_integer()}
  | {:strategy, :lifo | :fifo}
Link to this type

pool_opts()

View Source

Specs

pool_opts() :: [pool_opt() | {:destinations, [{atom(), pool_opts()}]}]
Link to this type

request()

View Source

Specs

request() :: %Mojito.Request{
  body: String.t() | nil,
  headers: headers() | nil,
  method: method(),
  opts: Keyword.t() | nil,
  url: String.t()
}
Link to this type

request_field()

View Source

Specs

request_field() ::
  {:method, method()}
  | {:url, String.t()}
  | {:headers, headers()}
  | {:body, String.t()}
  | {:opts, Keyword.t()}
Link to this type

request_kwlist()

View Source

Specs

request_kwlist() :: [request_field()]
Link to this type

response()

View Source

Specs

response() :: %Mojito.Response{
  body: String.t(),
  complete: boolean(),
  headers: headers(),
  size: term(),
  status_code: pos_integer()
}
Link to this type

url()

View Source

Specs

url() :: String.t()

Link to this section Callbacks

Link to this callback

delete(url)

View Source

Specs

delete(url()) :: {:ok, response()} | {:error, error()} | no_return()
Link to this callback

delete(url, headers)

View Source

Specs

delete(url(), headers()) :: {:ok, response()} | {:error, error()} | no_return()
Link to this callback

delete(url, headers, t)

View Source

Specs

delete(url(), headers(), Keyword.t()) ::
  {:ok, response()} | {:error, error()} | no_return()
Link to this callback

get(url)

View Source

Specs

get(url()) :: {:ok, response()} | {:error, error()} | no_return()
Link to this callback

get(url, headers)

View Source

Specs

get(url(), headers()) :: {:ok, response()} | {:error, error()} | no_return()
Link to this callback

get(url, headers, t)

View Source

Specs

get(url(), headers(), Keyword.t()) ::
  {:ok, response()} | {:error, error()} | no_return()
Link to this callback

head(url)

View Source

Specs

head(url()) :: {:ok, response()} | {:error, error()} | no_return()
Link to this callback

head(url, headers)

View Source

Specs

head(url(), headers()) :: {:ok, response()} | {:error, error()} | no_return()
Link to this callback

head(url, headers, t)

View Source

Specs

head(url(), headers(), Keyword.t()) ::
  {:ok, response()} | {:error, error()} | no_return()
Link to this callback

options(url)

View Source

Specs

options(url()) :: {:ok, response()} | {:error, error()} | no_return()
Link to this callback

options(url, headers)

View Source

Specs

options(url(), headers()) :: {:ok, response()} | {:error, error()} | no_return()
Link to this callback

options(url, headers, t)

View Source

Specs

options(url(), headers(), Keyword.t()) ::
  {:ok, response()} | {:error, error()} | no_return()
Link to this callback

patch(url)

View Source

Specs

patch(url()) :: {:ok, response()} | {:error, error()} | no_return()
Link to this callback

patch(url, headers)

View Source

Specs

patch(url(), headers()) :: {:ok, response()} | {:error, error()} | no_return()
Link to this callback

patch(url, headers, payload)

View Source

Specs

patch(url(), headers(), payload()) ::
  {:ok, response()} | {:error, error()} | no_return()
Link to this callback

patch(url, headers, payload, t)

View Source

Specs

patch(url(), headers(), payload(), Keyword.t()) ::
  {:ok, response()} | {:error, error()} | no_return()
Link to this callback

post(url)

View Source

Specs

post(url()) :: {:ok, response()} | {:error, error()} | no_return()
Link to this callback

post(url, headers)

View Source

Specs

post(url(), headers()) :: {:ok, response()} | {:error, error()} | no_return()
Link to this callback

post(url, headers, payload)

View Source

Specs

post(url(), headers(), payload()) ::
  {:ok, response()} | {:error, error()} | no_return()
Link to this callback

post(url, headers, payload, t)

View Source

Specs

post(url(), headers(), payload(), Keyword.t()) ::
  {:ok, response()} | {:error, error()} | no_return()
Link to this callback

put(url)

View Source

Specs

put(url()) :: {:ok, response()} | {:error, error()} | no_return()
Link to this callback

put(url, headers)

View Source

Specs

put(url(), headers()) :: {:ok, response()} | {:error, error()} | no_return()
Link to this callback

put(url, headers, payload)

View Source

Specs

put(url(), headers(), payload()) ::
  {:ok, response()} | {:error, error()} | no_return()
Link to this callback

put(url, headers, payload, t)

View Source

Specs

put(url(), headers(), payload(), Keyword.t()) ::
  {:ok, response()} | {:error, error()} | no_return()
Link to this callback

request(arg1)

View Source

Specs

request(request() | request_kwlist()) :: {:ok, response()} | {:error, error()}
Link to this callback

request(method, url)

View Source

Specs

request(method(), url()) :: {:ok, response()} | {:error, error()} | no_return()
Link to this callback

request(method, url, headers)

View Source

Specs

request(method(), url(), headers()) ::
  {:ok, response()} | {:error, error()} | no_return()
Link to this callback

request(method, url, headers, body)

View Source

Specs

request(method(), url(), headers(), body()) ::
  {:ok, response()} | {:error, error()} | no_return()
Link to this callback

request(method, url, headers, body, t)

View Source

Specs

request(method(), url(), headers(), body(), Keyword.t()) ::
  {:ok, response()} | {:error, error()} | no_return()