From 8cd06e33b5f13af73b2d859942224bb2db9c4998 Mon Sep 17 00:00:00 2001
From: Andrey Petrov <andrey.petrov@shazow.net>
Date: Mon, 3 Aug 2020 11:32:16 -0400
Subject: [PATCH] set: Add Interface, ZeroValue helper

---
 set/set.go | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/set/set.go b/set/set.go
index 92ef1bb..0b08e8c 100644
--- a/set/set.go
+++ b/set/set.go
@@ -15,6 +15,25 @@ var ErrMissing = errors.New("item does not exist")
 // Returned when a nil item is added. Nil values are considered expired and invalid.
 var ErrNil = errors.New("item value must not be nil")
 
+// ZeroValue can be used when we only care about the key, not about the value.
+var ZeroValue = struct{}{}
+
+// Interface is the Set interface
+type Interface interface {
+	Clear() int
+	Each(fn IterFunc) error
+	// Add only if the item does not already exist
+	Add(item Item) error
+	// Set item, override if it already exists
+	Set(item Item) error
+	Get(key string) (Item, error)
+	In(key string) bool
+	Len() int
+	ListPrefix(prefix string) []Item
+	Remove(key string) error
+	Replace(oldKey string, item Item) error
+}
+
 type IterFunc func(key string, item Item) error
 
 type Set struct {