mirror of
https://github.com/ninenines/cowboy.git
synced 2025-07-16 05:00:24 +00:00
Add man pages for the parse/match/binding cowboy_req functions
This commit is contained in:
parent
bd34dfdedd
commit
7b248e5163
8 changed files with 371 additions and 7 deletions
48
doc/src/manual/cowboy_req.path_info.asciidoc
Normal file
48
doc/src/manual/cowboy_req.path_info.asciidoc
Normal file
|
@ -0,0 +1,48 @@
|
|||
= 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)],
|
||||
link:man:cowboy_req:host_info(3)[cowboy_req:host_info(3)]
|
Loading…
Add table
Add a link
Reference in a new issue