0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-15 04:30:25 +00:00

Partially update manual for the cowboy_req

Only the access functions have been modified so far.
This commit is contained in:
Loïc Hoguin 2016-11-05 14:17:30 +02:00
parent 8fe700f341
commit faca7866ed
No known key found for this signature in database
GPG key ID: 71366FF21851DF03
16 changed files with 1409 additions and 895 deletions

View file

@ -0,0 +1,51 @@
= cowboy_req:path(3)
== Name
cowboy_req:path - URI path
== Description
[source,erlang]
----
path(Req :: cowboy_req:req()) -> Path :: binary()
----
Return the path of the effective request URI.
The path can also be obtained using pattern matching:
[source,erlang]
----
#{path := Path} = Req.
----
== Arguments
Req::
The Req object.
== Return value
The path is returned as a binary string. It is case sensitive.
== Changelog
* *2.0*: Only the path is returned, it is no longer wrapped in a tuple.
* *1.0*: Function introduced.
== Examples
.Get the effective request URI's path
[source,erlang]
----
Path = cowboy_req:path(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:path_info(3)[cowboy_req:path_info(3)]