influxid

Documentation

Index

• Constants
• Variables
• func Decode(id string) (uint64, error)
• func Encode(id uint64) string
• func Validate(id string) error

Constants

const IDLength = 16

IDLength is the exact length a string (or a byte slice representing it) must have in order to be decoded into a valid ID.

Variables

var (
	// ErrInvalidID signifies invalid IDs.
	ErrInvalidID = errors.New("invalid ID")

	// ErrInvalidIDLength is returned when an ID has the incorrect number of bytes.
	ErrInvalidIDLength = errors.New("id must have a length of 16 bytes")
)

Functions

func Decode

func Decode(id string) (uint64, error)

Decode parses id as a hex-encoded byte-slice-string.

It errors if the input byte slice does not have the correct length or if it contains all zeros.

func Encode

func Encode(id uint64) string

Encode converts a uint64 to a hex-encoded byte-slice-string.

func Validate

func Validate(id string) error

Validate ensures that a passed string has a valid ID syntax. Checks that the string is of length 16, and is a valid hex-encoded uint.