Maverick.Route (Maverick v0.2.0) View Source

A struct detailing a Maverick Route. The contents are determined at compile time by the annotations applied to routable functions.

Maverick uses the routes to construct request handlers for each routable function at runtime.

Link to this section Summary

Types

args()

error_code()

method()

success_code()

t()

Functions

list_routes(otp_app, root_scope)

Takes an OTP app name and a root scope and returns a list of all routes the app defines as %MODULE structs.

Link to this section Types

args()

Specs

args() :: :params | :request | {:required_params, [atom()]}

error_code()

Specs

error_code() :: non_neg_integer()

method()

Specs

method() :: binary()

success_code()

Specs

success_code() :: non_neg_integer()

t()

Specs

t() :: %Maverick.Route{
  args: args(),
  error_code: error_code(),
  function: atom(),
  method: method(),
  module: module(),
  path: Maverick.Path.path(),
  raw_path: Maverick.Path.raw_path(),
  success_code: success_code()
}

Link to this section Functions

list_routes(otp_app, root_scope)

Specs

list_routes(Maverick.otp_app(), Maverick.root_scope()) :: [t()]

Takes an OTP app name and a root scope and returns a list of all routes the app defines as %MODULE structs.