0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-15 20:50:24 +00:00
cowboy/doc/src/manual/cowboy_req.has_resp_body.asciidoc
2016-12-21 15:47:44 +01:00

48 lines
880 B
Text

= cowboy_req:has_resp_body(3)
== Name
cowboy_req:has_resp_body - Is there a response body?
== Description
[source,erlang]
----
has_resp_body(Req :: cowboy_req:req()) -> boolean()
----
Return whether a response body has been set.
== Arguments
Req::
The Req object.
== Return value
A boolean indicating whether a response body has been set.
This function will return `false` when an empty response
body has been set.
== Changelog
* *1.0*: Function introduced.
== Examples
.Check whether a body has been set
[source,erlang]
----
false = cowboy_req:has_resp_body(Req0),
Req1 = cowboy_req:set_resp_body(<<"Hello!">>, Req0),
true = cowboy_req:has_resp_body(Req1),
Req = cowboy_req:set_resp_body(<<>>, Req1),
false = cowboy_req:has_resp_body(Req).
----
== See also
link:man:cowboy_req(3)[cowboy_req(3)],
link:man:cowboy_req:set_resp_body(3)[cowboy_req:set_resp_body(3)]