The highest tagged major version is v5.

bgreader

package

v1.0.3 Latest Latest Go to latest Published: Feb 4, 2025 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/mark5cinco/pgx

Links

Open Source Insights

Documentation ¶

Overview ¶

Package bgreader provides a io.Reader that can optionally buffer reads in the background.

Constants ¶

View Source

const (
	StatusStopped = iota
	StatusRunning
	StatusStopping
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type BGReader ¶

type BGReader struct {
	// contains filtered or unexported fields
}

BGReader is an io.Reader that can optionally buffer reads in the background. It is safe for concurrent use.

func New ¶

func New(r io.Reader) *BGReader

func (*BGReader) Read ¶

func (r *BGReader) Read(p []byte) (int, error)

Read implements the io.Reader interface.

func (*BGReader) Start ¶

func (r *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.

func (*BGReader) Status ¶

func (r *BGReader) Status() int32

Status returns the current status of the background reader.

func (*BGReader) Stop ¶

func (r *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.

Source Files ¶

View all Source files

bgreader.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL