aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/cowboy_req.has_resp_body.asciidoc
blob: d6b906828225c9401ab03a0821cd2aabb32b1714 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
= 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)]