filebuf

Documentation

Overview

Package filebuf implements io.SeekReader for os files. This is useful only for very large files with lots of seeking. (otherwise use ioutil.ReadFile or bufio)

Index

• Constants
• type Buf
  • func FromReader(rd io.Reader) (Buf, error)
  • func New(fname string) (Buf, error)
• type Stat

Constants

const Buflen = 1 << 20

Buflen is the size of the internal buffer. The code is designed to never need to reread unnecessarily

Types

type Buf

type Buf interface {
	io.ReadCloser
	io.Seeker
	Size() int64
	Stats() Stat
}

Buf is the implemented interface

func FromReader

func FromReader(rd io.Reader) (Buf, error)

FromReader creates a Buf by copying the contents of an io.Reader

func New

func New(fname string) (Buf, error)

New returns an initialized *fbuf or an error

type Stat

type Stat struct {
	Seeks int
	Reads int
	Bytes int64
}

Stat returns the number of underlying seeks and reads, and bytes read