mmap

Documentation

Overview

Package mmap provides memory mapped related utilities.

Index

• Variables
• func Alloc(size int) ([]byte, error)
• func Free(mem []byte) error
• func MustAlloc(size int) []byte
• func MustFree(mem []byte)

Variables

var PageSize = os.Getpagesize()

PageSize is the minimum allocation size. Allocations will use at least this size and are likely to be multiplied up to a multiple of this size.

Functions

func Alloc

func Alloc(size int) ([]byte, error)

Alloc allocates size bytes and returns a slice containing them. If the allocation fails it will return with an error. This is best used for allocations which are a multiple of the PageSize.

func Free

func Free(mem []byte) error

Free frees buffers allocated by Alloc. Note it should be passed the same slice (not a derived slice) that Alloc returned. If the free fails it will return with an error.

func MustAlloc

func MustAlloc(size int) []byte

MustAlloc allocates size bytes and returns a slice containing them. If the allocation fails it will panic. This is best used for allocations which are a multiple of the PageSize.

func MustFree

func MustFree(mem []byte)

MustFree frees buffers allocated by Alloc. Note it should be passed the same slice (not a derived slice) that Alloc returned. If the free fails it will panic.