Fix return type in LimitReader function

Dean Karn · Dean Karn · commit fcf0aa6b90e5 · 2019-05-10T16:00:43.000-07:00
LimitReader now returns *LimitedReader instead of io.Reader.
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # pkg
-![Project status](https://img.shields.io/badge/version-3.0.0-green.svg)
+![Project status](https://img.shields.io/badge/version-3.0.1-green.svg)
 [![Build Status](https://travis-ci.org/go-playground/pkg.svg?branch=master)](https://travis-ci.org/go-playground/pkg)
 [![Coverage Status](https://coveralls.io/repos/github/go-playground/pkg/badge.svg?branch=master)](https://coveralls.io/github/go-playground/pkg?branch=master)
 [![GoDoc](https://godoc.org/github.com/go-playground/pkg?status.svg)](https://godoc.org/github.com/go-playground/pkg)
diff --git a/io/limit_reader.go b/io/limit_reader.go
@@ -14,7 +14,7 @@ var (
 // LimitReader returns a Reader that reads from r
 // but stops with LimitedReaderEOF after n bytes.
 // The underlying implementation is a *LimitedReader.
-func LimitReader(r io.Reader, n int64) io.Reader {
+func LimitReader(r io.Reader, n int64) *LimitedReader {
 	return &LimitedReader{R: r, N: n}
 }
 

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ var (`
`14`	`14`	`// LimitReader returns a Reader that reads from r`
`15`	`15`	`// but stops with LimitedReaderEOF after n bytes.`
`16`	`16`	`// The underlying implementation is a *LimitedReader.`
`17`		`-func LimitReader(r io.Reader, n int64) io.Reader {`
	`17`	`+func LimitReader(r io.Reader, n int64) *LimitedReader {`
`18`	`18`	`return &LimitedReader{R: r, N: n}`
`19`	`19`	`}`
`20`	`20`