rawmap

README

rawmap

Copyright 2017- Tatsuhiro Aoshima (hiro4bbh@gmail.com).

Abstract

Package rawmap provides memory-mapped file functionalities.

See documents on GoDoc for details.

Documentation

Overview

Package rawmap provides memory-mapped file functionalities.

Index

• func MmapShared(file *os.File, start, length int, protmode ProtectionMode) ([]byte, error)
• func Munmap(b []byte) error
• type ProtectionMode
  • func (protmode ProtectionMode) OpenFlag() int
• type Slice

Functions

func MmapShared

func MmapShared(file *os.File, start, length int, protmode ProtectionMode) ([]byte, error)

MmapShared returns the byte slice to the region of the memory-mapped file with the specified protection mode.

func Munmap

func Munmap(b []byte) error

Munmap unmaps the memory-mapped file pointed by the byte slice b.

Types

type ProtectionMode

type ProtectionMode int

ProtectionMode is the type for supported protection modes.

const (
	PROTMODE_READONLY ProtectionMode = iota
	PROTMODE_READWRITE
)

The list of supported protection modes.

func (ProtectionMode) OpenFlag

func (protmode ProtectionMode) OpenFlag() int

OpenFlag returns the corresponding flag used in os.OpenFile.

type Slice

type Slice struct {
	Addr     uintptr
	Len, Cap int
}

Slice is the data structure used in golang runtime.