Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-ksuid Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 03:53:32 2022 GMT+0.
Next: Systems, Previous: The cl-ksuid Reference Manual, Up: The cl-ksuid Reference Manual [Contents][Index]
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: The cl-ksuid Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
K-sortable unique identifiers
Bob Uhl <bob.denver.co@gmail.com>
GPLv3
1.0.0
Next: Packages, Previous: Systems, Up: The cl-ksuid Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: cl-ksuid/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
cl-ksuid (system).
Next: cl-ksuid/cl-ksuid.lisp, Previous: cl-ksuid/cl-ksuid.asd, Up: Lisp [Contents][Index]
cl-ksuid (system).
Previous: cl-ksuid/package.lisp, Up: Lisp [Contents][Index]
package.lisp (file).
cl-ksuid (system).
Next: Definitions, Previous: Files, Up: The cl-ksuid Reference Manual [Contents][Index]
Packages are listed by definition order.
Previous: cl-ksuid-test, 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.
ksuid
common-lisp.
Next: Indexes, Previous: Packages, Up: The cl-ksuid Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Generic functions, Previous: Public Interface, Up: Public Interface [Contents][Index]
KSUID-EQUAL returns NIL unless X & Y are equivalent KSUIDs.
KSUID-UNIVERSAL-TIME returns the timestamp component of KSUID as a universal time.
STRING-TO-KSUID parses STRING into a KSUID. It signals a PARSE-ERROR error condition if STRING is an invalid KSUID.
Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
Next: Classes, Previous: Generic functions, Up: Public Interface [Contents][Index]
PRINT-OBJECT prints a KSUID to STREAM. It will signal a PRINT-NOT-READABLE error condition if *PRINT-READABLY* is non-nil.
Previous: Standalone methods, Up: Public Interface [Contents][Index]
KSUID represents a KSUID. Client code should use BYTES and PRINT-OBJECT to access the KSUID in raw & string form.
Client code should use the BYTES accessor, not access the slot directly.
(quote (vector (unsigned-byte 8)))
(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
This slot is read-only.
Previous: Public Interface, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Constants, Up: Internals [Contents][Index]
Previous: Definitions, Up: The cl-ksuid Reference Manual [Contents][Index]
| Jump to: | B D E F G I K M P S |
|---|
| Jump to: | B D E F G I K M P S |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
| Jump to: | +
B C S |
|---|
| Jump to: | +
B C S |
|---|
| Jump to: | C F K P S |
|---|
| Jump to: | C F K P S |
|---|