id

Documentation

Index

• Variables
• func IsEnabled(config *Config) bool
• type Config
• type Generator
  • func NewGenerator(config *Config, reader rand.Reader) (Generator, error)
• type KSUID
  • func (k *KSUID) Generate() string
• type NanoID
  • func (n *NanoID) Generate() string
• type ULID
  • func NewULID(reader rand.Reader) *ULID
  • func (k *ULID) Generate() string
• type UUID
  • func (g *UUID) Generate() string
• type XID
  • func (x *XID) Generate() string

Variables

var ErrNotFound = errors.New("id: generator not found")

ErrNotFound for id.

var Module = fx.Options(
	fx.Provide(NewGenerator),
)

Module for fx.

Functions

func IsEnabled

func IsEnabled(config *Config) bool

IsEnabled the config.

Types

type Config

type Config struct {
	Kind string `yaml:"kind,omitempty" json:"kind,omitempty" toml:"kind,omitempty"`
}

Config for id.

type Generator

type Generator interface {
	// Generate an identifier.
	Generate() string
}

Generator to generate an identifier.

func NewGenerator

func NewGenerator(config *Config, reader rand.Reader) (Generator, error)

NewGenerator from config.

type KSUID

type KSUID struct{}

KSUID generator.

func (*KSUID) Generate

func (k *KSUID) Generate() string

Generate a KSUID.

type NanoID

type NanoID struct{}

NanoID generator.

func (*NanoID) Generate

func (n *NanoID) Generate() string

Generate a NanoID.

type ULID

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

ULID generator.

func NewULID

func NewULID(reader rand.Reader) *ULID

NewULID creates a new ULID generator.

func (*ULID) Generate

func (k *ULID) Generate() string

Generate a ULID.

type UUID

type UUID struct{}

UUID generator.

func (*UUID) Generate

func (g *UUID) Generate() string

Generate a UUID.

type XID

type XID struct{}

XID generator.

func (*XID) Generate

func (x *XID) Generate() string

Generate an XID.