mmap

Documentation

Overview

Package mmap provides a way to memory-map a file.

Index

• type ReaderAt
  • func New(f *os.File) (*ReaderAt, error)
  • func Open(filename string) (*ReaderAt, error)
  • func (r *ReaderAt) At(i int) byte
  • func (r *ReaderAt) Close() error
  • func (r *ReaderAt) Len() int
  • func (r *ReaderAt) ReadAt(p []byte, off int64) (int, error)

Types

type ReaderAt

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

ReaderAt reads a memory-mapped file.

Like any io.ReaderAt, clients can execute parallel ReadAt calls, but it is not safe to call Close and reading methods concurrently.

func New

func New(f *os.File) (*ReaderAt, error)

New memory-maps the given file for reading.

func Open

func Open(filename string) (*ReaderAt, error)

Open memory-maps the named file for reading.

func (*ReaderAt) At

func (r *ReaderAt) At(i int) byte

At returns the byte at index i.

func (*ReaderAt) Close

func (r *ReaderAt) Close() error

Close closes the reader.

func (*ReaderAt) Len

func (r *ReaderAt) Len() int

Len returns the length of the underlying memory-mapped file.

func (*ReaderAt) ReadAt

func (r *ReaderAt) ReadAt(p []byte, off int64) (int, error)

ReadAt implements the io.ReaderAt interface.