list: doc comments & tidying

Author: bbasata

internal/proto5server/server_listresource_test.go

@@ -106,10 +106,14 @@ func TestServerListResource(t *testing.T) {
 					}
 
 					result := req.NewListResult()
-					result.Identity.Set(ctx, resources[name].ThingResourceIdentity)
-					result.Resource.Set(ctx, resources[name])
 					result.DisplayName = name
 
+					diags = result.Identity.Set(ctx, resources[name].ThingResourceIdentity)
+					result.Diagnostics.Append(diags...)
+
+					diags = result.Resource.Set(ctx, resources[name])
+					result.Diagnostics.Append(diags...)
+
 					results = append(results, result)
 				}
 				resp.Results = slices.Values(results)

internal/proto6server/server_listresource_test.go

@@ -106,10 +106,14 @@ func TestServerListResource(t *testing.T) {
 					}
 
 					result := req.NewListResult()
-					result.Identity.Set(ctx, resources[name].ThingResourceIdentity)
-					result.Resource.Set(ctx, resources[name])
 					result.DisplayName = name
 
+					diags = result.Identity.Set(ctx, resources[name].ThingResourceIdentity)
+					result.Diagnostics = append(result.Diagnostics, diags...)
+
+					diags = result.Resource.Set(ctx, resources[name])
+					result.Diagnostics = append(result.Diagnostics, diags...)
+
 					results = append(results, result)
 				}
 				resp.Results = slices.Values(results)
@@ -128,10 +132,13 @@ func TestServerListResource(t *testing.T) {
 
 		r.ListMethod = func(ctx context.Context, req list.ListRequest, resp *list.ListResultsStream) {
 			result := req.NewListResult()
-			result.Identity.Set(ctx, resources["plateau"].ThingResourceIdentity)
 			result.DisplayName = "plateau"
 
-			resp.Results = slices.Values([]list.ListResult{result})
+			diags := result.Identity.Set(ctx, resources["plateau"].ThingResourceIdentity)
+			result.Diagnostics = append(result.Diagnostics, diags...)
+
+			results := []list.ListResult{result}
+			resp.Results = slices.Values(results)
 		}
 
 		return r

list/list_resource.go

@@ -103,6 +103,8 @@ type ListRequest struct {
 	ResourceIdentitySchema fwschema.Schema
 }
 
+// NewListResult creates a new [ListResult] with convenient defaults
+// for each field.
 func (r ListRequest) NewListResult() ListResult {
 	identity := &tfsdk.ResourceIdentity{Schema: r.ResourceIdentitySchema}
 	resource := &tfsdk.Resource{Schema: r.ResourceSchema}
@@ -132,10 +134,10 @@ type ListResultsStream struct {
 }
 
 // NoListResults is an iterator that pushes zero results.
-var NoListResults = func(func(ListResult) bool) {}
+var NoListResults = func(push func(ListResult) bool) {}
 
 // ListResultsStreamDiagnostics returns a function that yields a single
-// [[ListResult]] with the given Diagnostics
+// [ListResult] with the given Diagnostics
 func ListResultsStreamDiagnostics(diags diag.Diagnostics) iter.Seq[ListResult] {
 	return func(push func(ListResult) bool) {
 		if !push(ListResult{Diagnostics: diags}) {
@@ -144,7 +146,8 @@ func ListResultsStreamDiagnostics(diags diag.Diagnostics) iter.Seq[ListResult] {
 	}
 }
 
-// ListResult represents a listed managed resource instance.
+// ListResult represents a listed managed resource instance. For convenience,
+// create new values using [NewListResult] instead of struct literals.
 type ListResult struct {
 	// Identity is the identity of the managed resource instance.
 	//