aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/cowboy_req.path_info.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/manual/cowboy_req.path_info.asciidoc')
-rw-r--r--doc/src/manual/cowboy_req.path_info.asciidoc48
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/src/manual/cowboy_req.path_info.asciidoc b/doc/src/manual/cowboy_req.path_info.asciidoc
new file mode 100644
index 0000000..d114640
--- /dev/null
+++ b/doc/src/manual/cowboy_req.path_info.asciidoc
@@ -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)]