mmap

package

v0.27.0 Latest Latest Go to latest Published: May 20, 2020 License: BSD-3-Clause Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Rendered for

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

This section is empty.

This section is empty.

This section is empty.

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

Reader 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 Open(filename string) (*Reader, error)

Open memory-maps the named file for reading.

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

At returns the byte at index i.

func (r *Reader) Close() error

Close closes the reader.

func (r *Reader) Len() int

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

func (r *Reader) Read(p []byte) (int, error)

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

ReadAt implements the io.ReaderAt interface.

func (r *Reader) ReadByte() (byte, error)

func (r *Reader) Seek(offset int64, whence int) (int64, error)