add comment on Header() about nil metadata

grpc · Aug 25, 2023 · 4a6d059 · 4a6d059
1 parent 9e2a636
commit 4a6d059
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/stream.go b/stream.go
@@ -91,7 +91,9 @@ type Stream interface {
 // status package.
 type ClientStream interface {
 	// Header returns the header metadata received from the server if there
-	// is any. It blocks if the metadata is not ready to read.
+	// is any. It blocks if the metadata is not ready to read.  If the metadata
+	// is nil and the error is also nil, then the stream was terminated without
+	// headers, and the status can be discovered by calling RecvMsg.
 	Header() (metadata.MD, error)
 	// Trailer returns the trailer metadata from the server, if there is any.
 	// It must only be called after stream.CloseAndRecv has returned, or