memmap

Documentation

Index

• func GetFileSize(filename string) int64
• type File
  • func MapExisting(filename string, offset int64, length int) (*File, error)
  • func NewFile(filename string, offset int64, length int) (*File, error)
  • func (mmap *File) Close() (err error)
  • func (mmap *File) GetMemoryPtr() unsafe.Pointer
  • func (mmap *File) GetMemorySize() int

Functions

func GetFileSize

func GetFileSize(filename string) int64

GetFileSize is a helper function to retrieve file size

Types

type File

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

File is the wrapper around memory mapped file

func MapExisting

func MapExisting(filename string, offset int64, length int) (*File, error)

MapExisting is the factory method used to create memory maps for existing file. This function will fail if the file does not exist.

func NewFile

func NewFile(filename string, offset int64, length int) (*File, error)

NewFile is a factory method to create a new memory mapped file with the specified capacity

func (*File) Close

func (mmap *File) Close() (err error)

Close attempts to unmap the mapped memory region

func (*File) GetMemoryPtr

func (mmap *File) GetMemoryPtr() unsafe.Pointer

GetMemoryPtr return the pointer to the mapped region of the file

func (*File) GetMemorySize

func (mmap *File) GetMemorySize() int

GetMemorySize return the size of the mapped region of the file