guid

package

v0.0.0-...-f198d9b Latest Latest Go to latest Published: Nov 19, 2023 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Rendered for

Package guid provides utilities to marshal and unmarshal GUIDs.

This representation of GUID is compatible with golang.org/x/sys/windows and can be used wherever syscall interface/func expects golang.org/x/sys/windows.GUID. Unlike github.com/google/uuid, encoding is always little endian.

This section is empty.

This section is empty.

This section is empty.

type GUID struct {
	Data1 uint32
	Data2 uint16
	Data3 uint16
	Data4 [8]byte
}

GUID represents a GUID/UUID.

It has the same structure as golang.org/x/sys/windows.GUID so that it can be used with functions expecting that type. It is defined as its own type so that fmt.Stringer, json.Marshaler, json.Unmarshaler, encoding.TextMarshaler and encoding.TextUnmarshaler can be supported. The representation matches that used by native Windows code.

func MustParseGUID[T ~string | ~[]byte](input T) GUID

MustParseGUID parses input as GUID, but upon errors panics.

func NewGUID() GUID

Generate new [RFC 4122] v4 GUID.

func ParseGUID[T ~string | ~[]byte](input T) (GUID, error)

ParseGUID parses a string/byte slice containing a GUID and returns the GUID. The following formats are currently supported are

func (g GUID) AppendString(buf []byte) []byte

AppendString appends hexadecimal encoded string representation of GUID to buf.

func (g GUID) IsZero() bool

IsZero returns true if GUID is empty.

func (g GUID) MarshalJSON() ([]byte, error)

MarshalText returns the text representation of the GUID.

func (g GUID) MarshalText() ([]byte, error)

MarshalText returns the text representation of the GUID.

func (g GUID) String() string

String formats GUID into `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` format.

func (g *GUID) UnmarshalJSON(data []byte) error

UnmarshalJSON takes the json representation of a GUID, and unmarshal it into this GUID.

func (g *GUID) UnmarshalText(text []byte) error

UnmarshalText takes the text representation of a GUID, and unmarshal it into this GUID.