commonfile

Documentation

Overview

Common data file features.

Index

• func ConsecutiveTwenty0s(buf gommap.MMap) bool
• type File
  • func Open(name string, growth uint64) (file *File, err error)
  • func (file *File) CheckSize(more uint64) bool
  • func (file *File) CheckSizeAndEnsure(more uint64)
  • func (file *File) Clear()
  • func (file *File) Close() error
  • func (file *File) Flush() error

Functions

func ConsecutiveTwenty0s

func ConsecutiveTwenty0s(buf gommap.MMap) bool

Return true if the buffer begins with twenty consecutive 0s.

Types

type File

type File struct {
	Name           string // File path and name
	UsedSize, Size uint64
	Growth         uint64
	Fh             *os.File    // File handle
	Buf            gommap.MMap // Mapped file buffer
}

func Open

func Open(name string, growth uint64) (file *File, err error)

Open the file, or create it if non-existing.

func (*File) CheckSize

func (file *File) CheckSize(more uint64) bool

Return true only if the file still has room for more data.

func (*File) CheckSizeAndEnsure

func (file *File) CheckSizeAndEnsure(more uint64)

Ensure that the file has enough room for more data. Grow the file if necessary.

func (*File) Clear

func (file *File) Clear()

Overwrite the file with 0s and return to its initial size.

func (*File) Close

func (file *File) Close() error

Close the file.

func (*File) Flush

func (file *File) Flush() error

Synchronize file buffer with underlying storage device.