cowboy_req.bindings.asciidoc 950 B

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. = cowboy_req:bindings(3)
  2. == Name
  3. cowboy_req:bindings - Access all values bound from the route
  4. == Description
  5. [source,erlang]
  6. ----
  7. bindings(Req :: cowboy_req:req()) -> cowboy_router:bindings()
  8. ----
  9. Return a map containing all bindings.
  10. == Arguments
  11. Req::
  12. The Req object.
  13. == Return value
  14. By default values are case sensitive binary strings, however
  15. constraints may change the type of this value (for example
  16. automatically converting numbers to integer).
  17. == Changelog
  18. * *2.0*: Only the values are returned, they are no longer wrapped in a tuple.
  19. * *1.0*: Function introduced.
  20. == Examples
  21. .Get all bindings
  22. [source,erlang]
  23. ----
  24. Bindings = cowboy_req:bindings(Req).
  25. ----
  26. == See also
  27. link:man:cowboy_req(3)[cowboy_req(3)],
  28. link:man:cowboy_req:binding(3)[cowboy_req:binding(3)],
  29. link:man:cowboy_req:host_info(3)[cowboy_req:host_info(3)],
  30. link:man:cowboy_req:path_info(3)[cowboy_req:path_info(3)],
  31. link:man:cowboy_router(3)[cowboy_router(3)]