From: Filippo Valsorda <filippo@golang.org>
Date: Tue, 1 Jul 2025 09:51:37 +0000 (+0200)
Subject: hash: document that Clone may only return ErrUnsupported or a nil error
X-Git-Tag: go1.25rc3~5^2~52
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=dd687c386016445b2f4abc2a958963dd2056d95f;p=gostls13.git

hash: document that Clone may only return ErrUnsupported or a nil error

Updates #69521

Change-Id: I6a6a6964ce384a80c4c89efe67c260dc6e9ed6c8
Reviewed-on: https://go-review.googlesource.com/c/go/+/685235
Auto-Submit: Filippo Valsorda <filippo@golang.org>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Austin Clements <austin@google.com>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
Auto-Submit: Austin Clements <austin@google.com>
---

diff --git a/src/hash/hash.go b/src/hash/hash.go
index d4b9a91663..24ee9929c9 100644
--- a/src/hash/hash.go
+++ b/src/hash/hash.go
@@ -64,7 +64,8 @@ type Hash64 interface {
 // unless GOFIPS140=v1.0.0 is set.
 //
 // If a hash can only determine at runtime if it can be cloned (e.g. if it wraps
-// another hash), it may return an error wrapping [errors.ErrUnsupported].
+// another hash), Clone may return an error wrapping [errors.ErrUnsupported].
+// Otherwise, Clone must always return a nil error.
 type Cloner interface {
 	Hash
 	Clone() (Cloner, error)