ulids

Documentation

Overview

Package ulids is a lightweight wrapper around the github.com/oklog/ulid package that provides some common functionality (like checking if a ULID is null or is zero) as well as a process-global, cryptographically random, monotonic, and thread-safe ulid generation mechanism that can be used from external packages

Index

• Variables
• func Bytes(uid any) ([]byte, error)
• func FromTime(ts time.Time) ulid.ULID
• func IsZero(uid ulid.ULID) bool
• func MustBytes(uid any) []byte
• func MustParse(uid any) (id ulid.ULID)
• func New() ulid.ULID
• func Parse(uid any) (ulid.ULID, error)

Variables

var (
	ErrUnknownType = errors.New("cannot parse input: unknown type")
)

var Null = ulid.ULID{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}

Null ULID pre-allocated for easier checking.

Functions

func Bytes

func Bytes(uid any) ([]byte, error)

Bytes parses a ULID and returns the []byte representation of the ULID

func FromTime

func FromTime(ts time.Time) ulid.ULID

FromTime creates a ULID with the specified timestamp

func IsZero

func IsZero(uid ulid.ULID) bool

IsZero determines if the specified uid is the Null or zero-valued ULID. Useful for determining if a ULID has been passed into a method or is valid

func MustBytes

func MustBytes(uid any) []byte

MustBytes parses the ULID into bytes but panics on errors

func MustParse

func MustParse(uid any) (id ulid.ULID)

MustParse parses the ULID but panics on errors

func New

func New() ulid.ULID

New creates a new montonically increasing ULID in a threadsafe manner using a cryptographically random source of entropy for security (e.g. to ensure that an attacker cannot guess the next ULID to be generated). If the ULID cannot be generated this method panics rather than returning an error

func Parse

func Parse(uid any) (ulid.ULID, error)

Parse a ULID from a string or a []byte (or return a ulid.ULID). This method makes it easier to convert any user-specified type into a ULID