reader

Documentation

Index

• type Initializable
• type ReadSeeker
  • func NewCompressedFileSeeker(path string, buffsize int) (ReadSeeker, error)
  • func NewCompressedSeeker(fs ReadSeeker) (ReadSeeker, error)
  • func NewFileReadSeeker(path string, buffsize int) ReadSeeker

Types

type Initializable

type Initializable interface {
	IsInitialized() bool
	Initialize() error
}

Initializable is an interface containing methods to initialize a ReadSeeker.

type ReadSeeker

type ReadSeeker interface {
	io.Reader
	io.Closer
	Initializable
	SeekOffset(offset int64) error
}

ReadSeeker is an interface used to capture a file reader with seek functionality.

func NewCompressedFileSeeker

func NewCompressedFileSeeker(path string, buffsize int) (ReadSeeker, error)

NewCompressedFileSeeker creates a ReadSeeker based on a file path.

func NewCompressedSeeker

func NewCompressedSeeker(fs ReadSeeker) (ReadSeeker, error)

NewCompressedSeeker wraps a ReadSeeker to compress its data on the fly.

func NewFileReadSeeker

func NewFileReadSeeker(path string, buffsize int) ReadSeeker

NewFileReadSeeker wraps a buffered file reader with Seeking functionality. Notice that Seek calls un-set the reader and require Initialize calls. This is to avoid potentially unnecessary disk IO.