xid

Documentation

Overview

Package xid provides a unique identifier generator based on xid.

Index

• type Setting
• type XID
  • func New(_ ...Setting) *XID
  • func (x XID) Gen() string
  • func (x XID) Name() string
  • func (x XID) Size() int
  • func (x XID) Validate(id string) bool

Types

type Setting

type Setting struct {
}

type XID

type XID struct{}

XID represents a unique identifier generator.

func New

func New(_ ...Setting) *XID

New creates a new instance of the XID identifier.

func (XID) Gen

func (x XID) Gen() string

Gen generates a new unique identifier.

func (XID) Name

func (x XID) Name() string

Name returns the name of the identifier.

func (XID) Size

func (x XID) Size() int

Size returns the size of the xid in bits.

func (XID) Validate

func (x XID) Validate(id string) bool

Validate checks if the provided id is a valid xid.