uid

README

go-uid

Go package providing a common interface for generating unique identifiers

Documentation

Documentation is incomplete at this time.

Important

Although the interfaces in this package are nearly stable in advance of a v1.0.0 release they may still change.

See also

• https://github.com/aaronland/go-uid-snowflake
• https://github.com/aaronland/go-uid-proxy

Documentation

Overview

Package uid provides a common interface for generating unique identifiers

Index

• Constants
• func AsInt64(u UID) (int64, bool)
• func RegisterProvider(ctx context.Context, scheme string, init_func ProviderInitializationFunc) error
• func Schemes() []string
• type Int64UID
  • func (u *Int64UID) String() string
  • func (u *Int64UID) Value() any
• type MultiUID
  • func (r *MultiUID) String() string
  • func (r *MultiUID) Value() any
• type NullProvider
  • func (n *NullProvider) SetLogger(ctx context.Context, logger *log.Logger) error
  • func (n *NullProvider) UID(ctx context.Context, args ...interface{}) (UID, error)
• type NullUID
  • func (n *NullUID) String() string
  • func (n *NullUID) Value() any
• type Provider
  • func NewNullProvider(ctx context.Context, uri string) (Provider, error)
  • func NewProvider(ctx context.Context, uri string) (Provider, error)
  • func NewRandomProvider(ctx context.Context, uri string) (Provider, error)
  • func NewStringProvider(ctx context.Context, uri string) (Provider, error)
  • func NewYMDProvider(ctx context.Context, uri string) (Provider, error)
• type ProviderInitializationFunc
• type RandomProvider
  • func (pr *RandomProvider) SetLogger(ctx context.Context, logger *log.Logger) error
  • func (pr *RandomProvider) UID(ctx context.Context, args ...interface{}) (UID, error)
• type StringProvider
  • func (pr *StringProvider) SetLogger(ctx context.Context, logger *log.Logger) error
  • func (pr *StringProvider) UID(ctx context.Context, args ...interface{}) (UID, error)
• type StringUID
  • func (u *StringUID) String() string
  • func (u *StringUID) Value() any
• type UID
  • func NewInt64UID(ctx context.Context, i int64) (UID, error)
  • func NewMultiUID(ctx context.Context, uids ...UID) UID
  • func NewNullUID(ctx context.Context) (UID, error)
  • func NewStringUID(ctx context.Context, s string) (UID, error)
  • func NewYMDUID(ctx context.Context, date time.Time) (UID, error)
• type YMDProvider
  • func (pr *YMDProvider) SetLogger(ctx context.Context, logger *log.Logger) error
  • func (pr *YMDProvider) UID(ctx context.Context, args ...interface{}) (UID, error)
• type YMDUID
  • func (u *YMDUID) String() string
  • func (u *YMDUID) Value() any

Constants

const NULL_SCHEME string = "null"

NULL_SCHEME is the URI scheme used to identify NullProvider instances.

const RANDOM_SCHEME string = "random"

const STRING_SCHEME string = "string"

const YMD_SCHEME string = "ymd"

Functions

func AsInt64

func AsInt64(u UID) (int64, bool)

func RegisterProvider

func RegisterProvider(ctx context.Context, scheme string, init_func ProviderInitializationFunc) error

RegisterProvider registers 'scheme' as a key pointing to 'init_func' in an internal lookup table used to create new `Provider` instances by the `NewProvider` method.

func Schemes

func Schemes() []string

Schemes returns the list of schemes that have been registered.

Types

type Int64UID

type Int64UID struct {
	UID
	// contains filtered or unexported fields
}

func (*Int64UID) String

func (u *Int64UID) String() string

func (*Int64UID) Value

func (u *Int64UID) Value() any

type MultiUID

type MultiUID struct {
	UID
	// contains filtered or unexported fields
}

func (*MultiUID) String

func (r *MultiUID) String() string

func (*MultiUID) Value

func (r *MultiUID) Value() any

type NullProvider

type NullProvider struct {
	Provider
}

type NullProvider implements the Provider interface to return empty (null) identifiers.

func (*NullProvider) SetLogger

func (n *NullProvider) SetLogger(ctx context.Context, logger *log.Logger) error

func (*NullProvider) UID

func (n *NullProvider) UID(ctx context.Context, args ...interface{}) (UID, error)

type NullUID

type NullUID struct {
	UID
}

type NullProvider implements the UID interface to return empty (null) identifiers.

func (*NullUID) String

func (n *NullUID) String() string

func (*NullUID) Value

func (n *NullUID) Value() any

type Provider

type Provider interface {
	UID(context.Context, ...interface{}) (UID, error)
	SetLogger(context.Context, *log.Logger) error
}

func NewNullProvider

func NewNullProvider(ctx context.Context, uri string) (Provider, error)

NewNullProvider

null://

func NewProvider

func NewProvider(ctx context.Context, uri string) (Provider, error)

NewProvider returns a new `Provider` instance configured by 'uri'. The value of 'uri' is parsed as a `url.URL` and its scheme is used as the key for a corresponding `ProviderInitializationFunc` function used to instantiate the new `Provider`. It is assumed that the scheme (and initialization function) have been registered by the `RegisterProvider` method.

func NewRandomProvider

func NewRandomProvider(ctx context.Context, uri string) (Provider, error)

func NewStringProvider

func NewStringProvider(ctx context.Context, uri string) (Provider, error)

func NewYMDProvider

func NewYMDProvider(ctx context.Context, uri string) (Provider, error)

type ProviderInitializationFunc

type ProviderInitializationFunc func(ctx context.Context, uri string) (Provider, error)

ProviderInitializationFunc is a function defined by individual provider package and used to create an instance of that provider

type RandomProvider

type RandomProvider struct {
	Provider
}

func (*RandomProvider) SetLogger

func (pr *RandomProvider) SetLogger(ctx context.Context, logger *log.Logger) error

func (*RandomProvider) UID

func (pr *RandomProvider) UID(ctx context.Context, args ...interface{}) (UID, error)

type StringProvider

type StringProvider struct {
	Provider
	// contains filtered or unexported fields
}

func (*StringProvider) SetLogger

func (pr *StringProvider) SetLogger(ctx context.Context, logger *log.Logger) error

func (*StringProvider) UID

func (pr *StringProvider) UID(ctx context.Context, args ...interface{}) (UID, error)

type StringUID

type StringUID struct {
	UID
	// contains filtered or unexported fields
}

func (*StringUID) String

func (u *StringUID) String() string

func (*StringUID) Value

func (u *StringUID) Value() any

type UID

type UID interface {
	Value() any
	String() string
}

func NewInt64UID

func NewInt64UID(ctx context.Context, i int64) (UID, error)

func NewMultiUID

func NewMultiUID(ctx context.Context, uids ...UID) UID

func NewNullUID

func NewNullUID(ctx context.Context) (UID, error)

func NewStringUID

func NewStringUID(ctx context.Context, s string) (UID, error)

func NewYMDUID

func NewYMDUID(ctx context.Context, date time.Time) (UID, error)

type YMDProvider

type YMDProvider struct {
	Provider
}

func (*YMDProvider) SetLogger

func (pr *YMDProvider) SetLogger(ctx context.Context, logger *log.Logger) error

func (*YMDProvider) UID

func (pr *YMDProvider) UID(ctx context.Context, args ...interface{}) (UID, error)

type YMDUID

type YMDUID struct {
	UID
	// contains filtered or unexported fields
}

func (*YMDUID) String

func (u *YMDUID) String() string

func (*YMDUID) Value

func (u *YMDUID) Value() any