Skip to content

docs: warn that zero-valued Digest needs New/Reset #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Solaris-star wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −0
Open

docs: warn that zero-valued Digest needs New/Reset #87

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ func (*Digest) WriteString(string) (int, error)
func (*Digest) Sum64() uint64
```

**Note:** a zero-valued `Digest` is not initialized. Call `New()` (or `Reset()` /
`ResetWithSeed`) before writing, especially if you embed `Digest` in another
struct (#65).

The package is written with optimized pure Go and also contains even faster
assembly implementations for amd64 and arm64. If desired, the `purego` build tag
opts into using the Go code even on those architectures.
Expand Down