README
¶
Guid
Globally unique identifiers offer a quick means of generating non-colliding values across a distributed system. For this implemenation, RFC 4122 governs the desired behavior.
What's in a name?
You have likely already noticed that RFC and some implementations refer to these structures as UUIDs (Universally Unique Identifiers), where as this project is annotated as GUIDs (Globally Unique Identifiers). The name Guid was selected to make clear this project's ties to the .NET struct Guid. The most obvious relationship is the desire to have the same format specifiers available in this library's Format and Parse methods as .NET would have in its ToString and Parse methods.
Installation
- Ensure you have the Go Programming Language installed on your system.
- Run the command:
go get -u github.com/marstr/guid
Contribution
Contributions are welcome! Feel free to send Pull Requests. Continuous Integration will ensure that you have conformed to Go conventions. Please remember to add tests for your changes.
Versioning
This library will adhere to the Semantic Versioning 2.0.0 specification. It may be worth noting this should allow for tools like glide to pull in this library with ease.
The Release Notes portion of this file will be updated to reflect the most recent major/minor updates, with the option to tag particular bug-fixes as well. Updates to the Release Notes for patches should be addative, where as major/minor updates should replace the previous version. If one desires to see the release notes for an older version, checkout that version of code and open this file.
Release Notes 1.1.*
v1.1.0
Adding support for JSON marshaling and unmarshaling.
Documentation
¶
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreationStrategy ¶ added in v0.2.0
type CreationStrategy string
CreationStrategy enumerates the values that are supported for populating the bits of a new Guid.
const ( CreationStrategyVersion1 CreationStrategy = "version1" CreationStrategyVersion2 CreationStrategy = "version2" CreationStrategyVersion3 CreationStrategy = "version3" CreationStrategyVersion4 CreationStrategy = "version4" CreationStrategyVersion5 CreationStrategy = "version5" )
These constants define the possible creation strategies available via this implementation of Guid.
type Format ¶ added in v0.2.0
type Format string
Format enumerates the values that are supported by Parse and Format
const ( FormatB Format = "B" // {00000000-0000-0000-0000-000000000000} FormatD Format = "D" // 00000000-0000-0000-0000-000000000000 FormatN Format = "N" // 00000000000000000000000000000000 FormatP Format = "P" // (00000000-0000-0000-0000-000000000000) FormatX Format = "X" // {0x00000000,0x0000,0x0000,{0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00}} FormatDefault Format = FormatD )
These constants define the possible string formats available via this implementation of Guid.
type GUID ¶
type GUID struct {
// contains filtered or unexported fields
}
GUID is a unique identifier designed to virtually guarantee non-conflict between values generated across a distributed system.
func Empty ¶
func Empty() GUID
Empty returns a copy of the default and empty GUID.
Example ¶
var example GUID
if example == Empty() {
fmt.Print("Example is Empty")
} else {
fmt.Print("Example is not Empty")
}
Output: Example is Empty
func NewGUIDs ¶ added in v0.2.0
func NewGUIDs(strategy CreationStrategy) (GUID, error)
NewGUIDs generates and returns a new globally unique identifier that conforms to the given strategy.
func Parse ¶
Parse instantiates a GUID from a text representation of the same GUID. This is the inverse of function family String()
func (GUID) MarshalJSON ¶ added in v1.1.0
MarshalJSON writes a GUID as a JSON string.
func (GUID) String ¶
String returns a text representation of a GUID in the default format.
Example ¶
fmt.Printf(Empty().String())
Output: 00000000-0000-0000-0000-000000000000
func (GUID) Stringf ¶ added in v0.2.0
Stringf returns a text representation of a GUID that conforms to the specified format. If an unrecognized format is provided, the empty string is returned.
Example ¶
fmt.Printf(Empty().Stringf(FormatB))
Output: {00000000-0000-0000-0000-000000000000}
func (*GUID) UnmarshalJSON ¶ added in v1.1.0
UnmarshalJSON parses a GUID from a JSON string token.
Source Files