RVV-B0011 · Exported function returning value of unexported type

btwiuse / k0s

Active

Exported function returning value of unexported type RVV-B0011

Anti-pattern

3 months ago — 3 years old

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	}

exported func NewHandleHijackListener returns unexported type *server.lys, which can be annoying to use

61	return l.Network()
62}
63
64func NewHandleHijackListener() *lys {65	return &lys{conns: make(chan net.Conn)}
66}

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	}

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.

type unexportedType string
func ExportedFunc() *unexportedType {
    return &unexportedType("some string")
}