From 36c15371eb7f898316cb379a6d0e85f66cac472e Mon Sep 17 00:00:00 2001 From: Alvaro Aleman Date: Sun, 22 Mar 2020 12:33:14 -0400 Subject: [PATCH] Lister codegen: Clarify that returned objects are read-only --- .../code-generator/cmd/lister-gen/generators/lister.go | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/staging/src/k8s.io/code-generator/cmd/lister-gen/generators/lister.go b/staging/src/k8s.io/code-generator/cmd/lister-gen/generators/lister.go index e10e9fb2f19..1a539c36e66 100644 --- a/staging/src/k8s.io/code-generator/cmd/lister-gen/generators/lister.go +++ b/staging/src/k8s.io/code-generator/cmd/lister-gen/generators/lister.go @@ -258,8 +258,10 @@ func (g *listerGenerator) GenerateType(c *generator.Context, t *types.Type, w io var typeListerInterface = ` // $.type|public$Lister helps list $.type|publicPlural$. +// All objects returned here must be treated as read-only. type $.type|public$Lister interface { // List lists all $.type|publicPlural$ in the indexer. + // Objects returned here must be treated as read-only. List(selector labels.Selector) (ret []*$.type|raw$, err error) // $.type|publicPlural$ returns an object that can list and get $.type|publicPlural$. $.type|publicPlural$(namespace string) $.type|public$NamespaceLister @@ -269,10 +271,13 @@ type $.type|public$Lister interface { var typeListerInterface_NonNamespaced = ` // $.type|public$Lister helps list $.type|publicPlural$. +// All objects returned here must be treated as read-only. type $.type|public$Lister interface { // List lists all $.type|publicPlural$ in the indexer. + // Objects returned here must be treated as read-only. List(selector labels.Selector) (ret []*$.type|raw$, err error) // Get retrieves the $.type|public$ from the index for a given name. + // Objects returned here must be treated as read-only. Get(name string) (*$.type|raw$, error) $.type|public$ListerExpansion } @@ -325,10 +330,13 @@ func (s *$.type|private$Lister) Get(name string) (*$.type|raw$, error) { var namespaceListerInterface = ` // $.type|public$NamespaceLister helps list and get $.type|publicPlural$. +// All objects returned here must be treated as read-only. type $.type|public$NamespaceLister interface { // List lists all $.type|publicPlural$ in the indexer for a given namespace. + // Objects returned here must be treated as read-only. List(selector labels.Selector) (ret []*$.type|raw$, err error) // Get retrieves the $.type|public$ from the indexer for a given namespace and name. + // Objects returned here must be treated as read-only. Get(name string) (*$.type|raw$, error) $.type|public$NamespaceListerExpansion }