Exported function returning value of unexported type RVV-B0011
Anti-pattern
13 days ago
—
2 years old
exported func NewResourceCacheCollector returns unexported type *gc.resourceCacheCollector, which can be annoying to use
13 cacheLifecycle db.ResourceCacheLifecycle
14}
15
16func NewResourceCacheCollector(cacheLifecycle db.ResourceCacheLifecycle) *resourceCacheCollector {17 return &resourceCacheCollector{
18 cacheLifecycle: cacheLifecycle,
19 }exported func NewBuildStepDelegate returns unexported type *engine.buildStepDelegate, which can be annoying to use
39 state exec.RunState,
40 clock clock.Clock,
41 policyChecker policy.Checker,
42) *buildStepDelegate { 43 return &buildStepDelegate{
44 build: build,
45 planID: planID,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 NewAuditor returns unexported type *auditor.auditor, which can be annoying to use
22 EnableWorkerAuditLog bool,
23 EnableVolumeAuditLog bool,
24 logger lager.Logger,
25) *auditor { 26 return &auditor{
27 EnableBuildAuditLog: EnableBuildAuditLog,
28 EnableContainerAuditLog: EnableContainerAuditLog,
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")
}