package bgreader

Import Path
	github.com/jackc/pgx/v5/pgconn/internal/bgreader (on go.dev)

Dependency Relation
	imports 3 packages, and imported by one package

Involved Source Files

	  d bgreader.go
		Package bgreader provides a io.Reader that can optionally buffer reads in the background.
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type BGReader (struct)
		BGReader is an io.Reader that can optionally buffer reads in the background. It is safe for concurrent use.

		Methods (total 4)
			(*BGReader) Read(p []byte) (int, error)
				Read implements the io.Reader interface.

			(*BGReader) Start()
				Start starts the backgrounder reader. If the background reader is already running this is a no-op. The background
				reader will stop automatically when the underlying reader returns an error.

			(*BGReader) Status() int32
				Status returns the current status of the background reader.

			(*BGReader) Stop()
				Stop tells the background reader to stop after the in progress Read returns. It is safe to call Stop when the
				background reader is not running.

		Implements (at least one exported)
			*BGReader : io.Reader
		As Outputs Of (at least one exported)
			func New(r io.Reader) *BGReader


Package-Level Functions (only one)

	 func New(r io.Reader) *BGReader
Package-Level Constants (total 3)

	const StatusRunning = 1
	const StatusStopped = 0
	const StatusStopping = 2

The pages are generated with Golds v0.6.7. (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 @Go100and1 (reachable from the left QR code) to get the latest news of Golds.