Exported function returning value of unexported type RVV-B0011
Anti-pattern
Major
6 months ago
—
4 years old
exported func NewManager returns unexported type *manager.manager, which can be annoying to use
11 _ k0s.Manager = NewManager()
12)
13
14func NewManager() *manager {15 return &manager{
16 Map: linkedhashmap.New(),
17 }exported func NewLys returns unexported type *server.lys, which can be annoying to use
29 return l.Network()
30}
31
32func NewLys() *lys {33 return &lys{
34 Conns: make(chan net.Conn),
35 }
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")
}