API Reference Dowser.Client v#0.1.0

View Source

Modules

Top-level convenience helpers shared across the Dowser family.

Low-level entry point for querying a search backend over HTTP.

Behaviour for casting a whole request/response body, wired onto a Dowser.Client.Config/request as :codec_adapter.

Builds a load/2 + dump/2 dispatcher from a list of Dowser.Client.Field mappings.

The built-in, backend-agnostic Dowser.Client.Codec.

Bundles everything needed to reach one search backend: its :endpoint, :auth, and the HTTP/JSON/codec adapters and options to use.

Generic Dowser client error.

Behaviour for casting a single value to and from its wire representation.

Behaviour implemented by every HTTP transport (:httpc, Req, :hackney).

HTTP transport error.

HTTP adapter backed by :hackney.

HTTP adapter backed by OTP's built-in :httpc client.

HTTP adapter backed by the Req library.

HTTP adapter for stubbing requests in tests.

Behaviour implemented by every JSON codec.

JSON codec error.

JSON adapter backed by the Jason library.

JSON adapter backed by Elixir's built-in JSON module.

JSON adapter backed by the Poison library.

Encode and decode NDJSON (newline-delimited JSON).

A fully-resolved HTTP request, ready to hand to an HTTP adapter.

A normalized HTTP response.

Generic retry policy for transient HTTP failures.