Exported function returning value of unexported type RVV-B0011
Anti-pattern
Major
a year ago
—
3 years old
exported method IntoIter returns unexported type servers.iterator, which can be annoying to use
156
157type Servers []*ServerWrapped
158
159func (ss Servers) IntoIter() iterator { return ss.ForEach }160
161func (ss Servers) ForEach(cb iterCb) bool {
162 for _, s := range ss {
Description
An exported function or method returning a value of an unexported type may be frustrating to use.
In Go, if the function or method starts with a lowercase letter, it is not exported outside the package.
Bad practice
type unexportedType string
func ExportedFunc() *unexportedType {
return &unexportedType("some string")
}
Recommended
type ExportedType string
func ExportedFunc() *ExportedType {
return &ExportedType("some string")
}