ulid

README

go-ulid

golang implimentation of ulid/javascript

warning

This is as close of a clone of the origninal code base as I could achieve, so some functions may end up being optimized later.

Documentation

Index

• Constants
• Variables
• func DecodeTime(id ULID) (int64, error)
• func EncodeRandom(length int, rng PRNG) (string, error)
• func EncodeTime(unix int64) (string, error)
• func FixULIDBase32(input string) string
• func FromUUID(uuid string) (string, error)
• func IncrementBase32(str string) (string, error)
• func IsValid(id string) bool
• type Factory
  • func NewFactory(maybe_rng_override ...PRNG) Factory
• type PRNG
• type ULID
  • func Next(seed int64, rng PRNG) (ULID, error)
• type UUID
  • func ToUUID(ulid ULID) (UUID, error)

Constants

const B32_CHARACTERS = "0123456789ABCDEFGHJKMNPQRSTVWXYZ"

const ENCODING = "0123456789ABCDEFGHJKMNPQRSTVWXYZ" // Crockford's Base32

const ENCODING_LEN = 32 // from ENCODING.length;

const MAX_ULID = "7ZZZZZZZZZZZZZZZZZZZZZZZZZ"

const MIN_ULID = "00000000000000000000000000"

const RANDOM_LEN = 16

const TIME_LEN = 10

const TIME_MAX int64 = 281474976710655 // from Math.pow(2, 48) - 1;

Variables

var ErrBase32IncorrectEncoding = errors.New("B32_ENC_INVALID")

var ErrDecodeTimeInvalidCharacter = errors.New("DEC_TIME_CHAR")

var ErrDecodeTimeValueMalformed = errors.New("DEC_TIME_MALFORMED")

var ErrEncodeTimeNegative = errors.New("ENC_TIME_NEG")

var ErrEncodeTimeSizeExceeded = errors.New("ENC_TIME_SIZE_EXCEED")

var ErrEncodeTimeValueMalformed = errors.New("ENC_TIME_MALFORMED")

var ErrPRNGDetectFailure = errors.New("PRNG_DETECT")

var ErrULIDInvalid = errors.New("ULID_INVALID")

var ErrUUIDInvalid = errors.New("UUID_INVALID")

var ErrUnexpected = errors.New("UNEXPECTED")

var REGEX = regexp.MustCompile("^[0-7][0-9a-hjkmnp-tv-zA-HJKMNP-TV-Z]{25}$")

var UUID_REGEX = regexp.MustCompile("^[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$")

Functions

func DecodeTime

func DecodeTime(id ULID) (int64, error)

func EncodeRandom

func EncodeRandom(length int, rng PRNG) (string, error)

func EncodeTime

func EncodeTime(unix int64) (string, error)

func FixULIDBase32

func FixULIDBase32(input string) string

func FromUUID

func FromUUID(uuid string) (string, error)

func IncrementBase32

func IncrementBase32(str string) (string, error)

FIXME this is a direct translation of https://github.com/ulid/javascript/blob/11c2067821ee19e4dc787ca4e0125a025485edc6/source/crockford.ts#L62

func IsValid

func IsValid(id string) bool

Types

type Factory

type Factory interface {
	NextSeeded(seed int64) (ULID, error)
	Next() (ULID, error)
}

func NewFactory

func NewFactory(maybe_rng_override ...PRNG) Factory

type PRNG

type PRNG func() (int64, error)

type ULID

type ULID string

func Next

func Next(seed int64, rng PRNG) (ULID, error)

type UUID

type UUID string

type Factory func(int64) ULID

func ToUUID

func ToUUID(ulid ULID) (UUID, error)