# Functions
Abs calls filepath.Abs but ignores the error and returns the original value if any error occurred.
DirectoryExists returns true if a directory(or file) exists, otherwise false.
DirList is a `DirListFunc` which renders directories and files in html, but plain, mode.
DirListRich is a `DirListFunc` which can be passed to `DirOptions.DirList` field to override the default file listing appearance.
FileServer returns a Handler which serves files from a specific file system.
FormatBytes returns a string representation of the "b" bytes.
IsHidden checks a file is hidden or not.
NewAPIBuilder creates & returns a new builder which is responsible to build the API and the router handler.
NewDefaultHandler returns the handler which is responsible to map the request with a route (aka mux implementation).
NewDynamicHandler returns a new router handler which is responsible handle each request with routes that can be added in serve-time.
NewRoute returns a new route based on its method, subdomain, the path (unparsed or original), handlers and the macro container which all routes should share.
NewRoutePathReverser returns a new path reverser based on a routes provider, needed to get a route based on its name.
NewRouter returns a new empty Router.
NewSubdomainPartyRedirectHandler returns a handler which can be registered through `UseRouter` or `Use` to redirect from the current request's subdomain to the one which the given `to` Party can handle.
NewSubdomainRedirectHandler returns a handler which can be registered through `UseRouter` or `Use` to redirect from the current request's subdomain to the given "toSubdomain".
NewSubdomainRedirectWrapper returns a router wrapper which if it's registered to the router via `router#WrapRouter` it redirects(StatusMovedPermanently) a subdomain or the root domain to another subdomain or to the root domain.
Param receives a parameter name prefixed with the ParamStart symbol.
RedirectAbsolute replies to the request with a redirect to an absolute URL.
RegisterMethods adds custom http methods to the "AllMethods" list.
StripPrefix returns a handler that serves HTTP requests by removing the given prefix from the request URL's Path and invoking the handler h.
TraceTitleColorCode returns the color code depending on the method or the status.
TypeByExtension returns the MIME type associated with the file extension ext.
TypeByFilename same as TypeByExtension but receives a filename path instead.
WildcardFileParam wraps a named parameter "file" with the trailing "path" macro parameter type.
WildcardParam receives a parameter name prefixed with the WildcardParamStart symbol.
WithHost enables the RoutePathReverser's URL feature.
WithScheme is an option for the RoutepathReverser, it sets the optional field "vscheme", v for virtual.
WithServer enables the RoutePathReverser's URL feature.
# Constants
MethodNone is a Virtual method to store the "offline" routes.
ParamStart the character in string representation where the underline router starts its dynamic named parameter.
RouteError log when a route already exists, shown after the `Build` state, server never starts.
RouteOverlap will overlap the new route to the previous one.
RouteOverride replaces an existing route with the new one, the default rule.
RouteSkip keeps the original route and skips the new one.
i.e subdomain./ -> Subdomain: subdomain.
SubdomainWildcardIndicator where a registered path starts with '*.'.
SubdomainWildcardPrefix where a registered path starts with "*./", then this route should accept any subdomain.
WildcardParamStart the character in string representation where the underline router starts its dynamic wildcard path parameter.
# Variables
AllMethods contains the valid HTTP Methods: "GET", "POST", "PUT", "DELETE", "CONNECT", "HEAD", "PATCH", "OPTIONS", "TRACE".
DefaultDirOptions holds the default settings for `FileServer`.
DirListRichTemplate is the html template the `DirListRich` function is using to render the directories and files.
ErrNotRouteAdder throws on `AddRouteUnsafe` when a registered `RequestHandler` does not implements the optional `AddRoute(*Route) error` method.
# Structs
APIBuilder the visible API for constructing the router and child routers.
APIContainer is a wrapper of a common `Party` featured by Dependency Injection.
Attachments options for files to be downloaded and saved locally by the client.
DirCacheOptions holds the options for the cached file system.
DirListRichOptions the options for the `DirListRich` helper function.
DirOptions contains the settings that `FileServer` can use to serve files.
ExecutionOptions is a set of default behaviors that can be changed in order to customize the execution flow of the routes' handlers with ease.
ExecutionRules gives control to the execution of the route handlers outside of the handlers themselves.
Route contains the information about a registered Route.
RoutePathReverser contains methods that helps to reverse a (dynamic) path from a specific route, route name is required because a route may being registered on more than one http method.
Router is the "director".
# Interfaces
Party is just a group joiner of routes which have the same prefix and share same middleware(s) also.
RoutesProvider should be implemented by iteral which contains the registered routes.
# Type aliases
DirListFunc is the function signature for customizing directory and file listing.
RoutePathReverserOption option signature for the RoutePathReverser.
RouteRegisterRule is a type of uint8.
WrapperFunc is used as an expected input parameter signature for the WrapRouter.