radex

v0.1.0

radex v0.1.0 Radex.Conn View Source

Helpers for documenting a Plug.Conn

Link to this section Summary

Types

t()

Functions

document(conn)

Document a Plug.Conn

document_request(conn)

Document the request half of the Conn

document_response(conn)

Document the response half of the Conn

Link to this section Types

Link to this type t() View Source 
t() :: %Radex.Conn{request: term, response: term}

Link to this section Functions

Link to this function document(conn) View Source 
document(conn :: Plug.Conn.t) :: t

Document a Plug.Conn

Prepares it for writing by fetching all information required from the conn.

Link to this function document_request(conn) View Source 
document_request(conn :: Plug.Conn.t) :: Radex.Conn.Request.t

Document the request half of the Conn

Link to this function document_response(conn) View Source 
document_response(conn :: Plug.Conn.t) :: Radex.Conn.Response.t

Document the response half of the Conn