Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrLimitExceeded = errors.New("io: read limit exceeded")
ErrLimitExceeded identifies reads that exceed a configured byte limit.
Functions ¶
func Copy ¶ added in v0.65.0
Copy copies from src to dst until either EOF is reached on src or the context is canceled. It returns the number of bytes copied and the first error encountered while copying, if any.
Note: This implementation wraps the reader with a context check, which means it won't benefit from WriterTo optimization in io.Copy if the source implements it. This is a trade-off for being able to cancel the operation on context cancellation.
func MaxBytesReader ¶ added in v0.73.0
MaxBytesReader returns a reader that exposes at most n bytes from r. It returns a MaxBytesError when a read proves that r contains more than n bytes. Detecting overflow consumes one byte beyond the limit from r. A negative limit is treated as zero.
Types ¶
type CountingReader ¶ added in v0.62.0
type CountingReader struct {
// contains filtered or unexported fields
}
CountingReader wraps an io.Reader and counts the number of bytes read. Note: This implementation is NOT thread-safe. It should not be used concurrently from multiple goroutines.
func NewCountingReader ¶ added in v0.62.0
func NewCountingReader(r io.Reader) *CountingReader
NewCountingReader creates a new CountingReader that wraps the provided io.Reader.
func (*CountingReader) BytesRead ¶ added in v0.62.0
func (c *CountingReader) BytesRead() int64
BytesRead returns the number of bytes read.
type MaxBytesError ¶ added in v0.73.0
type MaxBytesError struct {
Limit int64
}
MaxBytesError is returned by MaxBytesReader when its read limit is exceeded.
func (*MaxBytesError) Error ¶ added in v0.73.0
func (e *MaxBytesError) Error() string
func (*MaxBytesError) Is ¶ added in v0.73.0
func (*MaxBytesError) Is(target error) bool
type ReadSeekCloserAt ¶ added in v0.50.0
type ReadSeekCloserAt interface {
io.ReadSeekCloser
io.ReaderAt
}
func NopCloser ¶
func NopCloser(r ReadSeekerAt) ReadSeekCloserAt
NopCloser returns a ReadSeekCloserAt with a no-op Close method wrapping the provided Reader r.
type ReadSeekerAt ¶ added in v0.50.0
type ReadSeekerAt interface {
io.ReadSeeker
io.ReaderAt
}
func NewReadSeekerAt ¶ added in v0.45.0
func NewReadSeekerAt(r io.Reader) (ReadSeekerAt, error)
func NewReadSeekerAtWithSize ¶ added in v0.50.0
func NewReadSeekerAtWithSize(r io.Reader) (ReadSeekerAt, int64, error)