aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrad Fitzpatrick <bradfitz@golang.org>2015-12-17 01:39:28 +0000
committerBrad Fitzpatrick <bradfitz@golang.org>2015-12-17 02:46:04 +0000
commit64de502caa3f89560756f1fa8534c665cca9ea6c (patch)
tree120d726d03228b26e3018d3372763d57f5ebb08a
parent8350e065568c9b9885c136bbda0b38f1f9acbb38 (diff)
downloadgo-64de502caa3f89560756f1fa8534c665cca9ea6c.tar.gz
go-64de502caa3f89560756f1fa8534c665cca9ea6c.zip
net/http: update Response.Trailer doc
I updated this in the previous commit (https://golang.org/cl/17931) but noticed a typo. and it still wasn't great. The Go 1.5 text was too brief to know how to use it: // Trailer maps trailer keys to values, in the same // format as the header. Change-Id: I33c49b6a4a7a3596735a4cc7865ad625809da900 Reviewed-on: https://go-review.googlesource.com/17932 Reviewed-by: Russ Cox <rsc@golang.org>
-rw-r--r--src/net/http/response.go18
1 files changed, 11 insertions, 7 deletions
diff --git a/src/net/http/response.go b/src/net/http/response.go
index 0e39ed3a3a..57ae364f57 100644
--- a/src/net/http/response.go
+++ b/src/net/http/response.go
@@ -72,14 +72,18 @@ type Response struct {
// ReadResponse nor Response.Write ever closes a connection.
Close bool
- // Trailer maps trailer keys to values, in the same
- // format as the header.
+ // Trailer maps trailer keys to values in the same
+ // format as Header.
//
- // The Trailer initially contains only the server's
- // pre-declared trailer keys, but with nil values. Trailer
- // must not be access concurrently with Read calls on the
- // Body. After Body.Read has returned io.EOF, Trailer can be read
- // again and will contain any values sent by the server.
+ // The Trailer initially contains only nil values, one for
+ // each key specified in the server's "Trailer" header
+ // value. Those values are not added to Header.
+ //
+ // Trailer must not be accessed concurrently with Read calls
+ // on the Body.
+ //
+ // After Body.Read has returned io.EOF, Trailer will contain
+ // any trailer values sent by the server.
Trailer Header
// The Request that was sent to obtain this Response.