diff options
| author | Damien Neil <dneil@google.com> | 2022-07-11 09:49:14 -0700 |
|---|---|---|
| committer | Damien Neil <dneil@google.com> | 2022-07-12 04:04:17 +0000 |
| commit | d3d7998756c33f69706488cade1cd2b9b10a4c7f (patch) | |
| tree | 3517a24c2711b7654dde25837b1ba19c9dfb6fb3 | |
| parent | 126c22a09824a7b52c019ed9a1d198b4e7781676 (diff) | |
| download | go-d3d7998756c33f69706488cade1cd2b9b10a4c7f.tar.gz go-d3d7998756c33f69706488cade1cd2b9b10a4c7f.zip | |
net/http: clarify that MaxBytesReader returns *MaxBytesError
A MaxBytesReader returns a *MaxBytesError when reading beyond
its limit, not a MaxBytesError.
Fixes #53764.
Change-Id: Icac3aeac96fd8b172f951241f8f111cda633752c
Reviewed-on: https://go-review.googlesource.com/c/go/+/416914
Reviewed-by: Ian Lance Taylor <iant@google.com>
Run-TryBot: Damien Neil <dneil@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
| -rw-r--r-- | src/net/http/request.go | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/net/http/request.go b/src/net/http/request.go index d091f3c056..cead91d3d4 100644 --- a/src/net/http/request.go +++ b/src/net/http/request.go @@ -1126,8 +1126,8 @@ func readRequest(b *bufio.Reader) (req *Request, err error) { // MaxBytesReader is similar to io.LimitReader but is intended for // limiting the size of incoming request bodies. In contrast to // io.LimitReader, MaxBytesReader's result is a ReadCloser, returns a -// MaxBytesError for a Read beyond the limit, and closes the -// underlying reader when its Close method is called. +// non-nil error of type *MaxBytesError for a Read beyond the limit, +// and closes the underlying reader when its Close method is called. // // MaxBytesReader prevents clients from accidentally or maliciously // sending a large request and wasting server resources. If possible, |