ulidgen

package

v0.4.0 Latest Latest Go to latest Published: Apr 20, 2019 License: MIT Imports: 5 Imported by: 1

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

Package ulidgen generates ULIDs.

This section is empty.

This section is empty.

This section is empty.

type Clock interface {
	// Now provides the time part of the ULID.
	Now() time.Time
}

Clock provides the time part of the ULID.

type Generator struct {
	// contains filtered or unexported fields
}

Generator generates a ULID.

func NewGenerator(opts ...Option) *Generator

NewGenerator returns a new ULID generator.

func (g *Generator) Generate() (string, error)

Generate generates a new ID.

type Option interface {
	// contains filtered or unexported methods
}

Option configures a Generator using the functional options paradigm popularized by Rob Pike and Dave Cheney. If you're unfamiliar with this style, see https://commandcenter.blogspot.com/2014/01/self-referential-functions-and-design.html and https://dave.cheney.net/2014/10/17/functional-options-for-friendly-apis.

func EntropySource(entropy io.Reader) Option

EntropySource configures an entropy source of a generator.

func TimeSource(clock Clock) Option

TimeSource configures a time source of a generator.