HTTPipe

v0.9.0

HTTPipe v0.9.0 HTTPipe.InspectionHelpers

Helper module for formatting HTTPipe.Conn, HTTPipe.Request, and HTTPipe.Response structs.

This module offers a way to nicely report the state of Conn, Request, and Response structs using standard Inspect.Algebra documents, however the result is far too intrusive to be used as the default protocol implementation. Therefore, each module has an individual inspect/2 function that can be called which will display the output:

Summary

Functions

double_line_break(doc)

Inserts two lines above the algebra document for spacing

format_nested_with_header(body, header, type \\ :default)
format_section_head(header)
inspect_body(body, opts)
inspect_conn(conn, opts)
inspect_conn_status(status, opts)
inspect_error(error, opts)
inspect_full_url(base_url, params, opts)
inspect_header(k, v)
inspect_headers(headers)
inspect_http_version(version, opts)
inspect_method(method)
inspect_params(params, opts)
inspect_request(request, opts)
inspect_response(response, opts)
inspect_status_code(status_code, opts)
inspect_url(url, opts)

Functions

double_line_break(doc)

Specs

double_line_break(Inspect.Algebra.t) :: Inspect.Algebra.t

Inserts two lines above the algebra document for spacing

format_nested_with_header(body, header, type \\ :default)

Specs

format_nested_with_header(Inspect.Algebra.t, String.t, atom) :: Inspect.Algebra.t
format_section_head(header)

Specs

format_section_head(String.t) :: String.t
inspect_body(body, opts)

Specs

inspect_body(HTTPipe.Request.body, Inspect.Opts.t) :: Inspect.Algebra.t
inspect_conn(conn, opts)

Specs

inspect_conn(HTTPipe.Conn.t, Inspect.Opts.t) :: Inspect.Algebra.t
inspect_conn_status(status, opts)

Specs

inspect_conn_status(atom, Inspect.Opts.t) :: Inspect.Algebra.t
inspect_error(error, opts)

Specs

inspect_error(nil | HTTPipe.Conn.exception, Inspect.Opts.t) :: Inspect.Algebra.t
inspect_full_url(base_url, params, opts)

Specs

inspect_full_url(HTTPipe.Request.url, HTTPipe.Request.params, Inspect.Opts.t) :: Inspect.Algebra.t
inspect_header(k, v)

Specs

inspect_header(String.t, String.t) :: String.t
inspect_headers(headers)

Specs

inspect_headers(HTTPipe.Request.headers | HTTPipe.Response.headers) :: Inspect.Algebra.t
inspect_http_version(version, opts)

Specs

inspect_http_version(HTTPipe.Request.http_version, Inspect.Opts.t) :: Inspect.Algebra.t
inspect_method(method)

Specs

inspect_method(HTTPipe.Request.http_method) :: Inspect.Algebra.t
inspect_params(params, opts)

Specs

inspect_params(HTTPipe.Request.params, Inspect.Opts.t) :: Inspect.Algebra.t
inspect_request(request, opts)

Specs

inspect_request(nil | HTTPipe.Request.t, Inspect.Opts.t) :: Inspect.Algebra.t
inspect_response(response, opts)

Specs

inspect_response(HTTPipe.Response.t, Inspect.Opts.t) :: Inspect.Algebra.t
inspect_status_code(status_code, opts)

Specs

inspect_status_code(HTTPipe.Response.status_code, Inspect.Opts.t) :: Inspect.Algebra.t
inspect_url(url, opts)

Specs

inspect_url(HTTPipe.Request.url, Inspect.Opts.t) :: Inspect.Algebra.t