github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/x/io/read.go (about)

     1  // Copyright (c) 2020 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package io
    22  
    23  import (
    24  	"bufio"
    25  	"io"
    26  )
    27  
    28  // ResettableReader is a resettable reader.
    29  type ResettableReader interface {
    30  	io.Reader
    31  	Reset(r io.Reader)
    32  }
    33  
    34  // ResettableReaderOptions are options for a resettable reader.
    35  type ResettableReaderOptions struct {
    36  	ReadBufferSize int
    37  }
    38  
    39  // ResettableReaderFn creates a resettable reader.
    40  type ResettableReaderFn func(r io.Reader, opts ResettableReaderOptions) ResettableReader
    41  
    42  // defaultResettableReaderFn creates a default resettable reader.
    43  func defaultResettableReaderFn() ResettableReaderFn {
    44  	return func(r io.Reader, opts ResettableReaderOptions) ResettableReader {
    45  		return bufio.NewReaderSize(r, opts.ReadBufferSize)
    46  	}
    47  }