0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-15 04:30:25 +00:00
cowboy/doc/src/manual/cowboy_req.path_info.asciidoc

50 lines
953 B
Text
Raw Normal View History

= cowboy_req:path_info(3)
== Name
cowboy_req:path_info - Access the route's trailing path segments
== Description
[source,erlang]
----
path_info(Req :: cowboy_req:req()) -> cowboy_router:tokens()
----
Return the tokens for the trailing path segments.
This is the part of the host name that was matched using
the `...` notation.
== Arguments
Req::
The Req object.
== Return value
The tokens are returned as a list of case sensitive
binary strings.
== Changelog
* *2.0*: Only the tokens are returned, they are no longer wrapped in a tuple.
* *1.0*: Function introduced.
== Examples
.Get the path_info tokens
[source,erlang]
----
PathInfo = cowboy_req:path_info(Req).
----
== See also
link:man:cowboy_req(3)[cowboy_req(3)],
link:man:cowboy_req:binding(3)[cowboy_req:binding(3)],
link:man:cowboy_req:bindings(3)[cowboy_req:bindings(3)],
2016-12-22 12:53:21 +01:00
link:man:cowboy_req:host_info(3)[cowboy_req:host_info(3)],
link:man:cowboy_router(3)[cowboy_router(3)]