List as map

bucket_test.go

@@ -4,6 +4,7 @@ import (
 	"bytes"
 	"fmt"
 	"os"
+	"reflect"
 	"testing"
 
 	"github.com/joyrexus/buckets"
@@ -249,6 +250,55 @@ func TestPrefixItems(t *testing.T) {
 	}
 }
 
+// Ensure that a bucket that gets a non-existent key returns nil.
+func TestItemsAsMap(t *testing.T) {
+	bx := NewTestDB()
+	defer bx.Close()
+
+	things, err := bx.New([]byte("things"))
+	if err != nil {
+		t.Error(err.Error())
+	}
+
+	// Setup items to insert.
+	items := []struct {
+		Key, Value []byte
+	}{
+		{[]byte("A"), []byte("1")},   // `A` prefix match
+		{[]byte("AA"), []byte("2")},  // match
+		{[]byte("AAA"), []byte("3")}, // match
+		{[]byte("AAB"), []byte("2")}, // match
+		{[]byte("B"), []byte("O")},
+		{[]byte("BA"), []byte("0")},
+		{[]byte("BAA"), []byte("0")},
+	}
+
+	// Insert 'em.
+	if err := things.Insert(items); err != nil {
+		fmt.Printf("could not insert items in `things` bucket: %v\n", err)
+	}
+
+	got, err := things.ItemsAsMap()
+	if err != nil {
+		fmt.Printf("could not get map of items: %v\n", err)
+	}
+	want := map[string][]byte{
+		"A":   []byte("1"),
+		"AA":  []byte("2"),
+		"AAA": []byte("3"),
+		"AAB": []byte("2"),
+		"B":   []byte("O"),
+		"BA":  []byte("0"),
+		"BAA": []byte("0"),
+	}
+
+	// Check if inserted data is the same as retrieved
+	eq := reflect.DeepEqual(want, got)
+	if !eq {
+		t.Errorf("got %v, want %v", got, want)
+	}
+}
+
 // Show that we can get items for all keys with a given prefix.
 func ExampleBucket_PrefixItems() {
 	bx, _ := buckets.Open(tempfile())

buckets.go

@@ -122,6 +122,25 @@ func (bk *Bucket) Items() (items []Item, err error) {
 	})
 }
 
+// ItemsAsMap returns a key/value map (map[string]([]byte) of all elements.
+func (bk *Bucket) ItemsAsMap() (items map[string][]byte, err error) {
+	items = make(map[string][]byte)
+	return items, bk.db.View(func(tx *bolt.Tx) error {
+		c := tx.Bucket(bk.Name).Cursor()
+		var key, value []byte
+		for k, v := c.First(); k != nil; k, v = c.Next() {
+			if v != nil {
+				key = make([]byte, len(k))
+				copy(key, k)
+				value = make([]byte, len(v))
+				copy(value, v)
+				items[string(key)] = value
+			}
+		}
+		return nil
+	})
+}
+
 // PrefixItems returns a slice of key/value pairs for all keys with
 // a given prefix.  Each k/v pair in the slice is of type Item
 // (`struct{ Key, Value []byte }`).