fix!: no mixed receiver types (#23)

## Description

Currently, `bucket` and `Table` have mixed receiver types: some are pointer receviers, and others are value receivers.

As per the Go Wiki, [you can have value and pointer receivers, just don't mix them](https://go.dev/doc/faq#methods_on_values_or_pointers).

## Changes

- Replace all value receivers in `bucket` and `Table` with pointer receivers.

### Design Decisions

This decision was made due to the advice on the Go wiki.

## Checklist

- [x] Tests pass
- [x] Docs updated

Reviewed-on: #23
Co-authored-by: M.V. Hutz <git@maximhutz.me>
Co-committed-by: M.V. Hutz <git@maximhutz.me>

.golangci.yml

@@ -114,6 +114,9 @@ linters:
     # Reports uses of functions with replacement inside the testing package.
     - usetesting
 
+    # Reports mixed receiver types in structs/interfaces.
+    - recvcheck
+
   settings:
     revive:
       rules:
@@ -198,7 +201,7 @@ linters:
 
         # warns when initialism, variable or package naming conventions are not followed.
         - name: var-naming
-
+    
     misspell:
       # Correct spellings using locale preferences for US or UK.
       # Setting locale to US will correct the British spelling of 'colour' to 'color'.

cuckoo_fuzz_test.go

@@ -73,16 +73,16 @@ func FuzzInsertLookup(f *testing.F) {
 
 				delete(expected, step.key)
 
-				_, err = actual.Get(step.key)
+				_, ok := actual.Get(step.key)
-				assert.Error(err)
+				assert.False(ok)
 			} else {
 				err := actual.Put(step.key, step.value)
 				assert.NoError(err)
 
 				expected[step.key] = step.value
 
-				found, err := actual.Get(step.key)
+				found, ok := actual.Get(step.key)
-				assert.NoError(err)
+				assert.True(ok)
 				assert.Equal(step.value, found)
 			}
 

cuckoo_test.go

@@ -108,12 +108,12 @@ func TestGetMany(t *testing.T) {
 	}
 
 	for i := range 2_000 {
-		value, err := table.Get(i)
+		value, ok := table.Get(i)
 		if i < 1_000 {
-			assert.NoError(err)
+			assert.True(ok)
 			assert.Equal(value, true)
 		} else {
-			assert.Error(err)
+			assert.False(ok)
 		}
 	}
 }

doc_example_test.go

@@ -14,19 +14,19 @@ func Example_basic() {
 		fmt.Println("Put error:", err)
 	}
 
-	if item, err := table.Get(1); err != nil {
+	if item, ok := table.Get(1); !ok {
-		fmt.Println("Error:", err)
+		fmt.Println("Not Found 1!")
 	} else {
 		fmt.Println("Found 1:", item)
 	}
 
-	if item, err := table.Get(0); err != nil {
+	if item, ok := table.Get(0); !ok {
-		fmt.Println("Error:", err)
+		fmt.Println("Not Found 0!")
 	} else {
 		fmt.Println("Found 0:", item)
 	}
 
 	// Output:
 	// Found 1: Hello, World!
-	// Error: key '0' not found
+	// Not Found 0!
 }

subtable.go

@@ -19,11 +19,11 @@ type subtable[K, V any] struct {
 
 // location determines where in the subtable a certain key would be placed. If
 // the capacity is 0, this will panic.
-func (t subtable[K, V]) location(key K) uint64 {
+func (t *subtable[K, V]) location(key K) uint64 {
 	return t.hash(key) % t.capacity
 }
 
-func (t subtable[K, V]) get(key K) (value V, found bool) {
+func (t *subtable[K, V]) get(key K) (value V, found bool) {
 	if t.capacity == 0 {
 		return
 	}
@@ -54,7 +54,7 @@ func (t *subtable[K, V]) resize(capacity uint64) {
 	t.size = 0
 }
 
-func (t subtable[K, V]) update(key K, value V) (updated bool) {
+func (t *subtable[K, V]) update(key K, value V) (updated bool) {
 	if t.capacity == 0 {
 		return
 	}

table.go

@@ -95,24 +95,31 @@ func (t *Table[K, V]) shrink() error {
 	return t.resize(t.tableA.capacity / t.growthFactor)
 }
 
-// Get fetches the value for a key in the [Table]. Returns an error if no value
+// Get fetches the value for a key in the [Table]. Matches the comma-ok pattern
-// is found.
+// of a builtin map; see [Table.Find] for plain indexing.
-func (t *Table[K, V]) Get(key K) (value V, err error) {
+func (t *Table[K, V]) Get(key K) (value V, ok bool) {
 	if item, ok := t.tableA.get(key); ok {
-		return item, nil
+		return item, true
 	}
 
 	if item, ok := t.tableB.get(key); ok {
-		return item, nil
+		return item, true
 	}
 
-	return value, fmt.Errorf("key '%v' not found", key)
+	return
+}
+
+// Find fetches the value of a key. Matches direct indexing of a builtin map;
+// see [Table.Get] for a comma-ok pattern.
+func (t *Table[K, V]) Find(key K) (value V) {
+	value, _ = t.Get(key)
+	return
 }
 
 // Has returns true if a key has a value in the table.
 func (t *Table[K, V]) Has(key K) (exists bool) {
-	_, err := t.Get(key)
+	_, exists = t.Get(key)
-	return err == nil
+	return
 }
 
 // Put sets the value for a key. Returns error if its value cannot be set.