mmap

Documentation

Index

• Variables
• func Close(data []byte) error
• func Open(path string, writable bool, length int64) (data []byte, err error)
• type MMFile
  • func (m *MMFile) Close() error
  • func (m *MMFile) Flush(flags int) error
  • func (m *MMFile) Len() int64
  • func (m *MMFile) Open() error
  • func (m *MMFile) ReadAt(dest []byte, offset int64) (int, error)
  • func (m *MMFile) ReadUint64At(offset int64) uint64
  • func (m *MMFile) WriteAt(src []byte, offset int64) (int, error)
  • func (m *MMFile) WriteUint64At(num uint64, offset int64)

Variables

var (
	ErrUnmappedMemory  = errors.New("unmapped memory")
	ErrIndexOutOfBound = errors.New("offset out of mapped region")
)

Functions

func Close

func Close(data []byte) error

func Open

func Open(path string, writable bool, length int64) (data []byte, err error)

length is provide when writable for creation

Types

type MMFile

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

File reads/writes a memory-mapped file.

func (*MMFile) Close

func (m *MMFile) Close() error

func (*MMFile) Flush

func (m *MMFile) Flush(flags int) error

func (*MMFile) Len

func (m *MMFile) Len() int64

func (*MMFile) Open

func (m *MMFile) Open() error

func (*MMFile) ReadAt

func (m *MMFile) ReadAt(dest []byte, offset int64) (int, error)

func (*MMFile) ReadUint64At

func (m *MMFile) ReadUint64At(offset int64) uint64

func (*MMFile) WriteAt

func (m *MMFile) WriteAt(src []byte, offset int64) (int, error)

func (*MMFile) WriteUint64At

func (m *MMFile) WriteUint64At(num uint64, offset int64)

WriteUint64At writes num at offset.