View Source nova_router behaviour (nova v0.10.4)

Summary

Types

bindings/0
host_tree/0
options/0
routing_tree/0

Callbacks

routes/1

Functions

add_routes(App, Routes)
Add routes to the dispatch-table for the given app. The routes can be either a list of maps or a map. It use the same structure as the routes-callback in the router-module.
compile(Apps)
compiled_apps()
execute(Req, Env)
lookup_url(Path)
lookup_url(Host, Path)
lookup_url(Host, Path, Method)
render_status_page(StatusCode, Req)
render_status_page(StatusCode, Data, Req)
render_status_page(Host, StatusCode, Data, Req, Env)
routes(Env)

Types

Link to this type

bindings/0

View Source 
-type bindings() :: #{binary() := binary()}.
Link to this type

host_tree/0

View Source 
-type host_tree() ::
          #host_tree{hosts ::
                         [{Host :: binary() | '_',
                           Tree ::
                               #routing_tree{tree ::
                                                 [#node{segment :: term(),
                                                        value ::
                                                            [#node_comp{comparator :: '_' | binary(),
                                                                        value :: any()}],
                                                        children :: [#node{}],
                                                        is_binding :: boolean(),
                                                        is_wildcard :: boolean()}]}}],
                     options :: term()}.
Link to this type

options/0

View Source 
-type options() :: #{convert_to_binary := boolean(), use_strict := boolean()}.
Link to this type

routing_tree/0

View Source 
-type routing_tree() ::
          #routing_tree{tree ::
                            [#node{segment :: term(),
                                   value :: [#node_comp{comparator :: '_' | binary(), value :: any()}],
                                   children :: [#node{}],
                                   is_binding :: boolean(),
                                   is_wildcard :: boolean()}]}.

Callbacks

Link to this callback

routes/1

View Source 
-callback routes(Env :: atom()) -> Routes :: [map()].

Functions

Link to this function

add_routes(App, Routes)

View Source 
-spec add_routes(App :: atom(), Routes :: [map()] | map()) -> ok.
Add routes to the dispatch-table for the given app. The routes can be either a list of maps or a map. It use the same structure as the routes-callback in the router-module.
Link to this function

compile(Apps)

View Source 
-spec compile(Apps :: [atom() | {atom(), map()}]) -> host_tree().
Link to this function

compiled_apps()

View Source 
-spec compiled_apps() -> [{App :: atom(), Prefix :: list()}].
Link to this function

execute(Req, Env)

View Source 
-spec execute(Req, Env :: cowboy_middleware:env()) -> {ok, Req, Env0} | {stop, Req}
                 when Req :: cowboy_req:req(), Env0 :: cowboy_middleware:env().
Link to this function

lookup_url(Path)

View Source
Link to this function

lookup_url(Host, Path)

View Source
Link to this function

lookup_url(Host, Path, Method)

View Source
Link to this function

render_status_page(StatusCode, Req)

View Source 
-spec render_status_page(StatusCode :: integer(), Req :: cowboy_req:req()) ->
                            {ok, Req0 :: cowboy_req:req(), Env :: map()}.
Link to this function

render_status_page(StatusCode, Data, Req)

View Source 
-spec render_status_page(StatusCode :: integer(), Data :: map(), Req :: cowboy_req:req()) ->
                            {ok, Req0 :: cowboy_req:req(), Env :: map()}.
Link to this function

render_status_page(Host, StatusCode, Data, Req, Env)

View Source 
-spec render_status_page(Host :: binary() | atom(),
                         StatusCode :: integer(),
                         Data :: map(),
                         Req :: cowboy_req:req(),
                         Env :: map()) ->
                            {ok, Req0 :: cowboy_req:req(), Env :: map()}.
Link to this function

routes(Env)

View Source 
-spec routes(Env :: atom()) -> [map()].