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 (total 2, in which 1 is exported)

	/* sort exporteds 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.

		Fields (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			cond *sync.Cond
			r io.Reader
			readResults []readResult
			status int32
		Methods (total 6, in which 4 are exported)
			(*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.

			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*BGReader) bgRead()
			(*BGReader) readFromReadResults(p []byte) (int, error)
				readBackgroundResults reads a result previously read by the background reader. r.cond.L must be held.

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

	/* one unexported ... *//* one unexported: */
	 type readResult (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			buf *[]byte
			err error


Package-Level Functions (only one, which is exported)

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

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

The pages are generated with Golds v0.7.6. (GOOS=linux GOARCH=amd64)