uniqid

Documentation

Index

• Variables
• type BaseDirLocation
• type UniqID
  • func New(base BaseDirLocation) (*UniqID, error)
  • func (u *UniqID) String() string

Variables

var ErrUnsupportedOS = errors.New("unsupported uniqid os")

ErrUnsupportedOS indicates that an unsupported OS tried to store a uniqid as a file.

Types

type BaseDirLocation

type BaseDirLocation int

BaseDirLocation facilitates base directory location option enums.

const (
	InHome BaseDirLocation = iota
	InTmp
)

BaseDirLocation enums define the base directory location options.

type UniqID

type UniqID struct {
	ID uuid.UUID
}

UniqID manages the storage and retrieval of a unique id.

func New

func New(base BaseDirLocation) (*UniqID, error)

New retrieves or creates a new unique id.

func (*UniqID) String

func (u *UniqID) String() string

String implements fmt.Stringer.