Mention thread-safety. Closes #39

oschwald · Dec 24, 2019 · 6a033e6 · 6a033e6
1 parent ae1990f
commit 6a033e6
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/reader.go b/reader.go
@@ -20,6 +20,9 @@ var metadataStartMarker = []byte("\xAB\xCD\xEFMaxMind.com")
 
 // Reader holds the data corresponding to the MaxMind DB file. Its only public
 // field is Metadata, which contains the metadata from the MaxMind DB file.
+//
+// All of the methods on Reader are thread-safe. The struct may be safely
+// shared across goroutines.
 type Reader struct {
 	hasMappedFile     bool
 	buffer            []byte