Exported function returning value of unexported type RVV-B0011
Anti-pattern
10 days ago
—
8 months old
exported func NewPodLogger returns unexported type *local.podLogger, which can be annoying to use
115 streams sync.Map
116}
117
118func NewPodLogger(p *Provider) *podLogger {119 return &podLogger{provider: p}
120}
121
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")
}