mappedslice

mappedslice

mappedslice is a Go library for efficient, memory map-backed slices. It provides a way to work with large datasets by mapping files directly into memory, allowing for fast and efficient access and manipulation of data. Ideal for applications needing high-performance data handling without loading entire files into RAM.

Features:

• Memory-mapped slices for efficient file access
• Supports large datasets with minimal memory overhead
• Easy-to-use API for integrating with existing Go applications

Usage

New

func ExampleNew() {
	var err error
	if exampleSlice, err = New[int]("myfile.bat", 32); err != nil {
		// Handle error here
		return
	}
}

Slice.Get

func ExampleSlice_Get() {
	var (
		v   int
		ok bool
	)

	if v, ok = exampleSlice.Get(0); !ok {
		// Missing entry here
		return
	}

	fmt.Println("Value", v)
}

Slice.Set

func ExampleSlice_Set() {
	var err error
	if err = exampleSlice.Set(0, 1337); err != nil {
		// Handle error here
		return
	}
}

Slice.Append

func ExampleSlice_Append() {
	var err error
	if err = exampleSlice.Append(1337); err != nil {
		// Handle error here
		return
	}
}

Slice.InsertAt

func ExampleSlice_InsertAt() {
	var err error
	if err = exampleSlice.InsertAt(0, 1337); err != nil {
		// Handle error here
		return
	}
}

Slice.RemoveAt

func ExampleSlice_RemoveAt() {
	var err error
	if err = exampleSlice.RemoveAt(0); err != nil {
		// Handle error here
		return
	}
}

Slice.ForEach

func ExampleSlice_ForEach() {
	exampleSlice.ForEach(func(v int) (end bool) {
		fmt.Println("Value", v)
		return
	})
}

Slice.Cursor

func ExampleSlice_Cursor() {
	cur := exampleSlice.Cursor()
	v, ok := cur.Seek(1337)
	if !ok {
		fmt.Println("index is missing")
		return
	}

	fmt.Println("My seek value!", v)

	for ok {
		v, ok = cur.Next()
		fmt.Println("My next value!", v)
	}
}

Slice.Cursor (using previous)

func ExampleSlice_Cursor_prev() {
	cur := exampleSlice.Cursor()
	v, ok := cur.Seek(1337)
	if !ok {
		fmt.Println("index is missing")
		return
	}

	fmt.Println("My seek value!", v)

	for ok {
		v, ok = cur.Prev()
		fmt.Println("My previous value!", v)
	}
}

Slice.Len

func ExampleSlice_Len() {
	fmt.Println("Length", exampleSlice.Len())
}

Slice.Slice

func ExampleSlice_Slice() {
	fmt.Println("Slice copy", exampleSlice.Slice())
}