kv: Mention deadlock risk in ForEachBlob docstring

lukechampine · Mar 16, 2021 · 11b2401 · 11b2401
1 parent 4ccffb7
commit 11b2401
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/renter/renterutil/metadb.go b/renter/renterutil/metadb.go
@@ -46,7 +46,9 @@ type MetaDB interface {
 	AddBlob(b DBBlob) error
 	Blob(key []byte) (DBBlob, error)
 	DeleteBlob(key []byte) error
-	ForEachBlob(func(key []byte) error) error
+
+	// ForEachBlob calls fn on each key. fn must not modify the DB.
+	ForEachBlob(fn func(key []byte) error) error
 
 	AddChunk(m, n int, length uint64) (DBChunk, error)
 	Chunk(id uint64) (DBChunk, error)