class

Fossil::Router

Inherits Reference < Object

Router class. A instance of a class is a node in a route tree.

Constructors

new(path : Nil | String = nil, parameter : Nil | String = nil)

Initializer for Router.

Source

Instance methods

/(other : String) : self

New Routers are implicitly created with calling a slash operator.

root = Fossil::Router.new ""
root / "route_a/its_child"
root / "route_b/@param1:int/info"

Source

children

Routers that may can go after self and do not start with a path parameter.

Source

children=(children : Array(Router))

Routers that may can go after self and do not start with a path parameter.

Source

endpoints

Endpoints at the route that is resolved to current Router.

Source

endpoints=(endpoints : Hash(Fossil::MethodsEnum, Fossil::Endpoint))

Endpoints at the route that is resolved to current Router.

Source

param_children

Routers that may can go after self and do start with a path parameter. Type of a parameter is a key in a Hash, so its capacity is equal to 3.

Source

param_children=(param_children : Hash(Fossil::Param::PathParamTypeEnum, Router))

Routers that may can go after self and do start with a path parameter. Type of a parameter is a key in a Hash, so its capacity is equal to 3.

Source

parameter

Name of a path parameter a path that can be resolved to one of the endpoints down the tree from the current node starts with. While @path is a whole fragment between two slashes, @parameter is parsed from a fragment "@<parameter_name>:<parameter_type>", where <parameter_type> is of type Fossil::Param::PathParamTypeEnum (string that can be parsed to this enum).

Source

path

The first path fragment of a path that can be resolved to one of the endpoints down the tree from the current node. If @path.is_nil the fragment is a path parameter.

Source

trace(path : String, path_params = {} of String => Fossil::Param::PathParamType) : Tuple(Router, Hash(String, Fossil::Param::PathParamType))

Trace path down the tree from the current router and pass all found path parameters in path_params.

Source