package pbufio

Import Path
	github.com/gobwas/pool/pbufio (on go.dev)

Dependency Relation
	imports 3 packages, and imported by one package

Involved Source Files

	  d pbufio.go
		Package pbufio contains tools for pooling bufio.Reader and bufio.Writers.

	    pbufio_go110.go
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type ReaderPool (struct)
		ReaderPool contains logic of *bufio.Reader reuse with various size.

		Methods (total 2)
			(*ReaderPool) Get(r io.Reader, size int) *bufio.Reader
				Get returns bufio.Reader whose buffer has at least size bytes.

			(*ReaderPool) Put(br *bufio.Reader)
				Put takes ownership of bufio.Reader for further reuse.

		As Outputs Of (at least 2)
			func CustomReaderPool(opts ...pool.Option) *ReaderPool
			func NewReaderPool(min, max int) *ReaderPool
		As Types Of (only one)
			  var DefaultReaderPool *ReaderPool

	 type WriterPool (struct)
		WriterPool contains logic of *bufio.Writer reuse with various size.

		Methods (total 2)
			(*WriterPool) Get(w io.Writer, size int) *bufio.Writer
				Get returns bufio.Writer whose buffer has at least size bytes.

			(*WriterPool) Put(bw *bufio.Writer)
				Put takes ownership of bufio.Writer for further reuse.

		As Outputs Of (at least 2)
			func CustomWriterPool(opts ...pool.Option) *WriterPool
			func NewWriterPool(min, max int) *WriterPool
		As Types Of (only one)
			  var DefaultWriterPool *WriterPool


Package-Level Functions (total 8)

	 func CustomReaderPool(opts ...pool.Option) *ReaderPool
		CustomReaderPool creates new ReaderPool with given options.

	 func CustomWriterPool(opts ...pool.Option) *WriterPool
		CustomWriterPool creates new WriterPool with given options.

	 func GetReader(w io.Reader, size int) *bufio.Reader
		GetReader returns bufio.Reader whose buffer has at least size bytes. It returns
		its capacity for further pass to Put().
		Note that size could be ceiled to the next power of two.
		GetReader is a wrapper around DefaultReaderPool.Get().

	 func GetWriter(w io.Writer, size int) *bufio.Writer
		GetWriter returns bufio.Writer whose buffer has at least size bytes.
		Note that size could be ceiled to the next power of two.
		GetWriter is a wrapper around DefaultWriterPool.Get().

	 func NewReaderPool(min, max int) *ReaderPool
		NewReaderPool creates new ReaderPool that reuses writers which size is in
		logarithmic range [min, max].

	 func NewWriterPool(min, max int) *WriterPool
		NewWriterPool creates new WriterPool that reuses writers which size is in
		logarithmic range [min, max].

	 func PutReader(bw *bufio.Reader)
		PutReader takes bufio.Reader and its size for future reuse.
		It does not reuse bufio.Reader if size is not power of two or is out of pool
		min/max range.
		PutReader is a wrapper around DefaultReaderPool.Put().

	 func PutWriter(bw *bufio.Writer)
		PutWriter takes bufio.Writer for future reuse.
		It does not reuse bufio.Writer which underlying buffer size is not power of
		PutWriter is a wrapper around DefaultWriterPool.Put().


Package-Level Variables (total 2)

	  var DefaultReaderPool *ReaderPool
	  var DefaultWriterPool *WriterPool

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.