f3b01cb493
This patch adds a missing docstrings for exported identifiers, and adjust some of the existing ones to match the standard style. In some cases, the identifiers were un-exported after noticing they had no external users. Besides improving documentation, it also reduces the linter noise significantly.
37 lines
800 B
Go
37 lines
800 B
Go
// Package set implement sets for various types. Well, only string for now :)
|
|
package set
|
|
|
|
// String set.
|
|
type String struct {
|
|
m map[string]struct{}
|
|
}
|
|
|
|
// NewString returns a new string set, with the given values in it.
|
|
func NewString(values ...string) *String {
|
|
s := &String{}
|
|
s.Add(values...)
|
|
return s
|
|
}
|
|
|
|
// Add values to the string set.
|
|
func (s *String) Add(values ...string) {
|
|
if s.m == nil {
|
|
s.m = map[string]struct{}{}
|
|
}
|
|
|
|
for _, v := range values {
|
|
s.m[v] = struct{}{}
|
|
}
|
|
}
|
|
|
|
// Has checks if the set has the given value.
|
|
func (s *String) Has(value string) bool {
|
|
// We explicitly allow s to be nil *in this function* to simplify callers'
|
|
// code. Note that Add will not tolerate it, and will panic.
|
|
if s == nil || s.m == nil {
|
|
return false
|
|
}
|
|
_, ok := s.m[value]
|
|
return ok
|
|
}
|