Skip to content

docs: document uuid.Nil as the empty all-zero UUID #223

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

Closed
Solaris-star wants to merge 1 commit into from
Closed

docs: document uuid.Nil as the empty all-zero UUID #223

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
10 changes: 6 additions & 4 deletions hash.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@ import (
"hash"
)

// Well known namespace IDs and UUIDs
// Well known namespace IDs.
var (
NameSpaceDNS = MustParse("6ba7b810-9dad-11d1-80b4-00c04fd430c8")
NameSpaceURL = MustParse("6ba7b811-9dad-11d1-80b4-00c04fd430c8")
NameSpaceOID = MustParse("6ba7b812-9dad-11d1-80b4-00c04fd430c8")
NameSpaceX500 = MustParse("6ba7b814-9dad-11d1-80b4-00c04fd430c8")
Nil UUID // empty UUID, all zeros

// Nil is the empty UUID, with all 128 bits set to zero.
Nil UUID

// The Max UUID is special form of UUID that is specified to have all 128 bits set to 1.
Max = UUID{
Expand Down Expand Up @@ -45,15 +47,15 @@ func NewHash(h hash.Hash, space UUID, data []byte, version int) UUID {
// NewMD5 returns a new MD5 (Version 3) UUID based on the
// supplied name space and data. It is the same as calling:
//
// NewHash(md5.New(), space, data, 3)
// NewHash(md5.New(), space, data, 3)
func NewMD5(space UUID, data []byte) UUID {
return NewHash(md5.New(), space, data, 3)
}

// NewSHA1 returns a new SHA1 (Version 5) UUID based on the
// supplied name space and data. It is the same as calling:
//
// NewHash(sha1.New(), space, data, 5)
// NewHash(sha1.New(), space, data, 5)
func NewSHA1(space UUID, data []byte) UUID {
return NewHash(sha1.New(), space, data, 5)
}