Exported function returning value of unexported type RVV-B0011
Anti-pattern
a month ago
—
3 years old
exported func NewAccessor returns unexported type *accessor.access, which can be annoying to use
56 systemClaimValues []string,
57 teams []db.Team,
58 displayUserIdGenerator atc.DisplayUserIdGenerator,
59) *access { 60 a := &access{
61 verification: verification,
62 requiredRole: requiredRole,exported func NewCheckPipelineAccessHandlerFactory returns unexported type *auth.checkPipelineAccessHandlerFactory, which can be annoying to use
19
20func NewCheckPipelineAccessHandlerFactory(
21 teamFactory db.TeamFactory,
22) *checkPipelineAccessHandlerFactory {23 return &checkPipelineAccessHandlerFactory{
24 teamFactory: teamFactory,
25 }exported func NewCheckBuildWriteAccessHandlerFactory returns unexported type *auth.checkBuildWriteAccessHandlerFactory, which can be annoying to use
19
20func NewCheckBuildWriteAccessHandlerFactory(
21 buildFactory db.BuildFactory,
22) *checkBuildWriteAccessHandlerFactory {23 return &checkBuildWriteAccessHandlerFactory{
24 buildFactory: buildFactory,
25 }exported func NewCheckBuildReadAccessHandlerFactory returns unexported type *auth.checkBuildReadAccessHandlerFactory, which can be annoying to use
21
22func NewCheckBuildReadAccessHandlerFactory(
23 buildFactory db.BuildFactory,
24) *checkBuildReadAccessHandlerFactory { 25 return &checkBuildReadAccessHandlerFactory{
26 buildFactory: buildFactory,
27 }exported func NewTranslator returns unexported type *uidgid.translator, which can be annoying to use
23 Apply(*exec.Cmd)
24}
25
26func NewTranslator(mapper Mapper) *translator {27 return &translator{
28 mapper: mapper,
29 chown: os.Lchown,
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")
}