The cl-ksuid Reference Manual

Table of Contents

The cl-ksuid Reference Manual

This is the cl-ksuid Reference Manual, version 1.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Thu Mar 11 12:13:56 2021 GMT+0.

1 Introduction

cl-ksuid

cl-ksuid implements KSUIDs in Common Lisp. KSUIDs are short (20 byte or 27 base62 character) unique IDs composed of a 32-bit timestamp followed by 128 bits of randomness. Due to the timestamp, they are sortable by creation second. They are described further in A Brief History of the UUID.

E.g. 0puTTYvbQvWBglQicRUWdOdKnt9 or 0pw8wwIBsPD8yLcQS9rBSlIFet0.

KSUIDs may be created with (make-instance 'ksuid); they can be printed to a character stream so long as *print-readably* is nil; their bytes may be extracted with the BYTES reader. Finally, a string may be parsed as a KSUID with STRING-TO-KSUID.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-ksuid

Author

Bob Uhl <bob.denver.co@gmail.com>

License

GPLv3

Description

K-sortable unique identifiers

Version

1.0.0

Dependencies

• babel
• ironclad

Source

cl-ksuid.asd (file)

Components

• package.lisp (file)
• cl-ksuid.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 cl-ksuid.asd

Location

cl-ksuid.asd

Systems

cl-ksuid (system)

3.1.2 cl-ksuid/package.lisp

Parent

cl-ksuid (system)

Location

package.lisp

Packages

• cl-ksuid
• cl-ksuid-test

3.1.3 cl-ksuid/cl-ksuid.lisp

Dependency

package.lisp (file)

Parent

cl-ksuid (system)

Location

cl-ksuid.lisp

Exported Definitions

• bytes (method)
• ksuid (class)
• ksuid-equal (function)
• ksuid-universal-time (function)
• string-to-ksuid (function)

Internal Definitions

• +base62-characters* (constant)
• +epoch+ (constant)
• base-to-base (function)
• decode (function)
• define-constant (macro)
• encode (function)

4 Packages

Packages are listed by definition order.

4.1 cl-ksuid

CL-KSUID provides K-sorted unique identifiers as described in <URL:https://segment.com/blog/a-brief-history-of-the-uuid/> and implemented in <URL:https://github.com/segmentio/ksuid>; any incompatibility should be treated as a bug.

Source

package.lisp (file)

Nickname

ksuid

Use List

common-lisp

Used By List

cl-ksuid-test

Exported Definitions

• bytes (generic function)
• bytes (method)
• ksuid (class)
• ksuid-equal (function)
• ksuid-universal-time (function)
• string-to-ksuid (function)

Internal Definitions

• +base62-characters* (constant)
• +epoch+ (constant)
• base-to-base (function)
• decode (function)
• define-constant (macro)
• encode (function)

4.2 cl-ksuid-test

Source

package.lisp (file)

Use List

• cl-ksuid
• prove
• common-lisp

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: ksuid-equal X Y

KSUID-EQUAL returns NIL unless X & Y are equivalent KSUIDs.

Package

cl-ksuid

Source

cl-ksuid.lisp (file)

Function: ksuid-universal-time KSUID

KSUID-UNIVERSAL-TIME returns the timestamp component of KSUID as a universal time.

Package

cl-ksuid

Source

cl-ksuid.lisp (file)

Function: string-to-ksuid STRING

STRING-TO-KSUID parses STRING into a KSUID. It signals a PARSE-ERROR error condition if STRING is an invalid KSUID.

Package

cl-ksuid

Source

cl-ksuid.lisp (file)

5.1.2 Generic functions

Generic Function: bytes OBJECT

Package

cl-ksuid

Methods

Method: bytes (KSUID ksuid)

Client code should use the BYTES accessor, not access the slot directly.

Source

cl-ksuid.lisp (file)

5.1.3 Classes

Class: ksuid ()

KSUID represents a KSUID. Client code should use BYTES and PRINT-OBJECT to access the KSUID in raw & string form.

Package

cl-ksuid

Source

cl-ksuid.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• print-object (method)
• initialize-instance (method)
• bytes (method)

Direct slots

Slot: bytes

Client code should use the BYTES accessor, not access the slot directly.

Type

(quote (vector (unsigned-byte 8)))

Initargs

:bytes

Initform

(concatenate (quote (vector (unsigned-byte 8))) (ironclad:integer-to-octets (- (get-universal-time) cl-ksuid::+epoch+) :n-bits 32 :big-endian t) (ironclad:random-data 16))

Readers

bytes (generic function)

5.2 Internal definitions

5.2.1 Constants

Constant: +base62-characters*

Package

cl-ksuid

Source

cl-ksuid.lisp (file)

Constant: +epoch+

Package

cl-ksuid

Source

cl-ksuid.lisp (file)

5.2.2 Macros

Macro: define-constant NAME VALUE &optional DOC

Package

cl-ksuid

Source

cl-ksuid.lisp (file)

5.2.3 Functions

Function: base-to-base OCTETS IN-BASE OUT-BASE

Package

cl-ksuid

Source

cl-ksuid.lisp (file)

Function: decode STRING

Package

cl-ksuid

Source

cl-ksuid.lisp (file)

Function: encode OCTETS

Package

cl-ksuid

Source

cl-ksuid.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types