mmap

package module

v0.1.0 Latest Latest Go to latest Published: Sep 29, 2022 License: 0BSD Imports: 8 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

This is a simple wrapper over github.com/edsrzf/mmap-go which takes
care of opening and closing files and makes it easy to handle SIGBUS.

This section is empty.

This section is empty.

This section is empty.

type AddressError interface {
	runtime.Error
	Addr() uintptr
}

This is what the go runtime produces on SIGBUS and SIGSEGV. Unfortunately the type is not exported from the runtime.

type MMap mmap.MMap

func Map(fname string) (MMap, error)

Map this file into memory

func (m *MMap) Unmap()

Unmaps this mapping

func (m MMap) With(f func(data []byte)) (out error)

Call the provided function with the map data and convert any fault into a OffsetError.

type OffsetError struct {
	Offset uintptr
	Err    error
}

The function With produces this when a fault happens inside the provided mapping.

func (e *OffsetError) Error() string

func (e *OffsetError) Unwrap() error