Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-ksuid Reference Manual, version 1.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 03:54:18 2022 GMT+0.
• Introduction | What cl-ksuid is all about | |
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
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
.
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The cl-ksuid system |
Bob Uhl <bob.denver.co@gmail.com>
GPLv3
K-sortable unique identifiers
1.0.0
cl-ksuid.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
• The cl-ksuid.asd file | ||
• The cl-ksuid/package.lisp file | ||
• The cl-ksuid/cl-ksuid.lisp file |
Next: The cl-ksuid/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-ksuid.asd
cl-ksuid (system)
Next: The cl-ksuid/cl-ksuid․lisp file, Previous: The cl-ksuid․asd file, Up: Lisp files [Contents][Index]
cl-ksuid (system)
package.lisp
Previous: The cl-ksuid/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
cl-ksuid (system)
cl-ksuid.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The cl-ksuid package | ||
• The cl-ksuid-test package |
Next: The cl-ksuid-test package, Previous: Packages, Up: Packages [Contents][Index]
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.
package.lisp (file)
ksuid
common-lisp
Previous: The cl-ksuid package, Up: Packages [Contents][Index]
package.lisp (file)
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported functions | ||
• Exported generic functions | ||
• Exported classes |
Next: Exported generic functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
KSUID-EQUAL returns NIL unless X & Y are equivalent KSUIDs.
cl-ksuid.lisp (file)
KSUID-UNIVERSAL-TIME returns the timestamp component of KSUID as a universal time.
cl-ksuid.lisp (file)
STRING-TO-KSUID parses STRING into a KSUID. It signals a PARSE-ERROR error condition if STRING is an invalid KSUID.
cl-ksuid.lisp (file)
Next: Exported classes, Previous: Exported functions, Up: Exported definitions [Contents][Index]
Client code should use the BYTES accessor, not access the slot directly.
cl-ksuid.lisp (file)
Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
KSUID represents a KSUID. Client code should use BYTES and PRINT-OBJECT to access the KSUID in raw & string form.
cl-ksuid.lisp (file)
standard-object (class)
Client code should use the BYTES accessor, not access the slot directly.
(quote (vector (unsigned-byte 8)))
:bytes
(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))
bytes (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal constants | ||
• Internal macros | ||
• Internal functions |
Next: Internal macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
cl-ksuid.lisp (file)
cl-ksuid.lisp (file)
Next: Internal functions, Previous: Internal constants, Up: Internal definitions [Contents][Index]
cl-ksuid.lisp (file)
Previous: Internal macros, Up: Internal definitions [Contents][Index]
cl-ksuid.lisp (file)
cl-ksuid.lisp (file)
cl-ksuid.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | C F L |
---|
Jump to: | C F L |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | B D E F G K M S |
---|
Jump to: | B D E F G K M S |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | +
B C S |
---|
Jump to: | +
B C S |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | C K P S |
---|
Jump to: | C K P S |
---|