This is the frugal-uuid Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 04:55:04 2024 GMT+0.
frugal-uuid/frugal-uuid.asdfrugal-uuid/package.lispfrugal-uuid/frugal-uuid.lispfrugal-uuid/frugal-uuid-node.lispfrugal-uuid/frugal-uuid-clock.lispfrugal-uuid/frugal-uuid-random.lispfrugal-uuid/frugal-uuid-namespace.lispfrugal-uuid/frugal-uuid-v1.lispfrugal-uuid/frugal-uuid-v2.lispfrugal-uuid/frugal-uuid-v3.lispfrugal-uuid/frugal-uuid-v4.lispfrugal-uuid/frugal-uuid-v5.lispfrugal-uuid/frugal-uuid-v6.lispfrugal-uuid/frugal-uuid-v7.lispfrugal-uuid/frugal-uuid-v8.lispThe main system appears first, followed by any subsystem dependency.
frugal-uuidCommon Lisp UUID library with zero dependencies
Ákos Kiss <ak@coram.pub>
MIT License
package.lisp (file).
frugal-uuid.lisp (file).
frugal-uuid-node.lisp (file).
frugal-uuid-clock.lisp (file).
frugal-uuid-random.lisp (file).
frugal-uuid-namespace.lisp (file).
frugal-uuid-v1.lisp (file).
frugal-uuid-v2.lisp (file).
frugal-uuid-v3.lisp (file).
frugal-uuid-v4.lisp (file).
frugal-uuid-v5.lisp (file).
frugal-uuid-v6.lisp (file).
frugal-uuid-v7.lisp (file).
frugal-uuid-v8.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
frugal-uuid/frugal-uuid.asdfrugal-uuid/package.lispfrugal-uuid/frugal-uuid.lispfrugal-uuid/frugal-uuid-node.lispfrugal-uuid/frugal-uuid-clock.lispfrugal-uuid/frugal-uuid-random.lispfrugal-uuid/frugal-uuid-namespace.lispfrugal-uuid/frugal-uuid-v1.lispfrugal-uuid/frugal-uuid-v2.lispfrugal-uuid/frugal-uuid-v3.lispfrugal-uuid/frugal-uuid-v4.lispfrugal-uuid/frugal-uuid-v5.lispfrugal-uuid/frugal-uuid-v6.lispfrugal-uuid/frugal-uuid-v7.lispfrugal-uuid/frugal-uuid-v8.lispfrugal-uuid/frugal-uuid.lisppackage.lisp (file).
frugal-uuid (system).
clock-seq-hi-and-res (reader method).
(setf clock-seq-hi-and-res) (writer method).
clock-seq-low (reader method).
(setf clock-seq-low) (writer method).
compile-literal (function).
from-integer (function).
from-octets (function).
from-string (function).
from-sym (function).
make-nil (function).
make-omni (function).
node (reader method).
(setf node) (writer method).
print-object (method).
time-hi-and-version (reader method).
(setf time-hi-and-version) (writer method).
time-low (reader method).
(setf time-low) (writer method).
time-mid (reader method).
(setf time-mid) (writer method).
to-integer (function).
to-octets (function).
to-string (function).
to-sym (function).
uuid (class).
uuid-equal-p (function).
uuid= (function).
~ (macro).
integer-to-octets (function).
octets-to-integer (function).
frugal-uuid/frugal-uuid-node.lispfrugal-uuid.lisp (file).
frugal-uuid (system).
parse-node-id (function).
random-node-id (function).
frugal-uuid/frugal-uuid-clock.lispfrugal-uuid-node.lisp (file).
frugal-uuid (system).
*unix-timestamp-function* (special variable).
make-timestamp-generator (function).
random-clock-seq (function).
+100nanos-per-second+ (constant).
+millis-per-second+ (constant).
+nanos-per-milli+ (constant).
+nanos-per-second+ (constant).
+universal-time-unix-epoch-offset+ (constant).
+unix-time-uuid-epoch-offset-seconds+ (constant).
get-current-timestamp (function).
get-unix-time (function).
frugal-uuid/frugal-uuid-random.lispfrugal-uuid-clock.lisp (file).
frugal-uuid (system).
*random-number-function* (special variable).
*random-number-generator* (special variable).
*random-number-generator-init-function* (special variable).
initialize-random (function).
random-integer (function).
with-random (macro).
with-random-number-generator (macro).
frugal-uuid/frugal-uuid-namespace.lispfrugal-uuid-random.lisp (file).
frugal-uuid (system).
frugal-uuid/frugal-uuid-v1.lispfrugal-uuid-namespace.lisp (file).
frugal-uuid (system).
*v1-generator* (special variable).
*v1-generator-init-function* (special variable).
initialize-v1-generator (function).
make-v1 (function).
make-v1-from-timestamp (function).
make-v1-generator (function).
make-v1-integer (function).
make-v1-octets (function).
make-v1-string (function).
make-v1-sym (function).
with-v1-generator (macro).
+v1-clock-seq-max+ (constant).
floor100 (function).
v1-clock-seq (reader method).
(setf v1-clock-seq) (writer method).
v1-generator (class).
v1-node-id (reader method).
(setf v1-node-id) (writer method).
v1-timestamp-generator (reader method).
(setf v1-timestamp-generator) (writer method).
frugal-uuid/frugal-uuid-v2.lispfrugal-uuid-v1.lisp (file).
frugal-uuid (system).
frugal-uuid/frugal-uuid-v3.lispfrugal-uuid-v2.lisp (file).
frugal-uuid (system).
make-v3-from-integer (function).
make-v3-from-octets (function).
frugal-uuid/frugal-uuid-v4.lispfrugal-uuid-v3.lisp (file).
frugal-uuid (system).
make-v4 (function).
make-v4-from-integer (function).
make-v4-integer (function).
make-v4-octets (function).
make-v4-string (function).
make-v4-sym (function).
frugal-uuid/frugal-uuid-v5.lispfrugal-uuid-v4.lisp (file).
frugal-uuid (system).
make-v5-from-integer (function).
make-v5-from-octets (function).
frugal-uuid/frugal-uuid-v6.lispfrugal-uuid-v5.lisp (file).
frugal-uuid (system).
make-v6 (function).
make-v6-from-v1 (function).
make-v6-integer (function).
make-v6-octets (function).
make-v6-string (function).
make-v6-sym (function).
v6-time-low-and-version (function).
v6-time-mid (function).
v6-time-high (function).
frugal-uuid/frugal-uuid-v7.lispfrugal-uuid-v6.lisp (file).
frugal-uuid (system).
*v7-generator* (special variable).
*v7-generator-init-function* (special variable).
initialize-v7-generator (function).
make-v7 (function).
make-v7-from-timestamp (function).
make-v7-generator (function).
make-v7-integer (function).
make-v7-octets (function).
make-v7-string (function).
make-v7-sym (function).
with-v7-generator (macro).
+v7-random-counter-max+ (constant).
truncate-sub-ms (function).
v7-generator (class).
v7-random (function).
v7-random-counter (reader method).
(setf v7-random-counter) (writer method).
v7-random-small (function).
v7-timestamp-generator (reader method).
(setf v7-timestamp-generator) (writer method).
frugal-uuid/frugal-uuid-v8.lispfrugal-uuid-v7.lisp (file).
frugal-uuid (system).
make-v8 (function).
make-v8-integer (function).
make-v8-octets (function).
make-v8-string (function).
make-v8-sym (function).
Packages are listed by definition order.
frugal-uuidfuuid
common-lisp.
*ns-dns* (special variable).
*ns-oid* (special variable).
*ns-url* (special variable).
*ns-x500* (special variable).
*random-number-function* (special variable).
*random-number-generator* (special variable).
*random-number-generator-init-function* (special variable).
*unix-timestamp-function* (special variable).
*v1-generator* (special variable).
*v1-generator-init-function* (special variable).
*v7-generator* (special variable).
*v7-generator-init-function* (special variable).
clock-seq-hi-and-res (generic reader).
(setf clock-seq-hi-and-res) (generic writer).
clock-seq-low (generic reader).
(setf clock-seq-low) (generic writer).
compile-literal (function).
from-integer (function).
from-octets (function).
from-string (function).
from-sym (function).
initialize-random (function).
initialize-v1-generator (function).
initialize-v7-generator (function).
make-nil (function).
make-omni (function).
make-timestamp-generator (function).
make-v1 (function).
make-v1-from-timestamp (function).
make-v1-generator (function).
make-v1-integer (function).
make-v1-octets (function).
make-v1-string (function).
make-v1-sym (function).
make-v3-from-integer (function).
make-v3-from-octets (function).
make-v4 (function).
make-v4-from-integer (function).
make-v4-integer (function).
make-v4-octets (function).
make-v4-string (function).
make-v4-sym (function).
make-v5-from-integer (function).
make-v5-from-octets (function).
make-v6 (function).
make-v6-from-v1 (function).
make-v6-integer (function).
make-v6-octets (function).
make-v6-string (function).
make-v6-sym (function).
make-v7 (function).
make-v7-from-timestamp (function).
make-v7-generator (function).
make-v7-integer (function).
make-v7-octets (function).
make-v7-string (function).
make-v7-sym (function).
make-v8 (function).
make-v8-integer (function).
make-v8-octets (function).
make-v8-string (function).
make-v8-sym (function).
node (generic reader).
(setf node) (generic writer).
parse-node-id (function).
random-clock-seq (function).
random-integer (function).
random-node-id (function).
time-hi-and-version (generic reader).
(setf time-hi-and-version) (generic writer).
time-low (generic reader).
(setf time-low) (generic writer).
time-mid (generic reader).
(setf time-mid) (generic writer).
to-integer (function).
to-octets (function).
to-string (function).
to-sym (function).
uuid (class).
uuid-equal-p (function).
uuid= (function).
v6-time-low-and-version (function).
v6-time-mid (function).
with-random (macro).
with-random-number-generator (macro).
with-v1-generator (macro).
with-v7-generator (macro).
~ (macro).
+100nanos-per-second+ (constant).
+millis-per-second+ (constant).
+nanos-per-milli+ (constant).
+nanos-per-second+ (constant).
+universal-time-unix-epoch-offset+ (constant).
+unix-time-uuid-epoch-offset-seconds+ (constant).
+v1-clock-seq-max+ (constant).
+v7-random-counter-max+ (constant).
floor100 (function).
get-current-timestamp (function).
get-unix-time (function).
integer-to-octets (function).
octets-to-integer (function).
truncate-sub-ms (function).
v1-clock-seq (generic reader).
(setf v1-clock-seq) (generic writer).
v1-generator (class).
v1-node-id (generic reader).
(setf v1-node-id) (generic writer).
v1-timestamp-generator (generic reader).
(setf v1-timestamp-generator) (generic writer).
v6-time-high (function).
v7-generator (class).
v7-random (function).
v7-random-counter (generic reader).
(setf v7-random-counter) (generic writer).
v7-random-small (function).
v7-timestamp-generator (generic reader).
(setf v7-timestamp-generator) (generic writer).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Function should return the number of seconds since the unix epoch and the number of additional nanoseconds as a second value or NIL if unknown.
Dynamically bind source of randomness for creating uuid values.
Dynamically bind random number generator for creating uuid values.
Dynamically bind generator for creating version 1 uuid values.
Dynamically bind generator for creating version 7 uuid values.
Create uuid value from integer representation.
Create uuid value from a vector of octets.
Parse uuid value from canonical textual representation.
Create uuid value from a symbol.
Sets up alternate source of randomness for generating UUIDs.
The provided RANDOM-FN is expected to take two arguments: the first is a limit below which a non-negative random number should be generated and the second is the value returned by the INIT-FN function argument. When no random INIT-FN is provided, RANDOM-FN is called with a single LIMIT argument.
Create uuid value with all bits set to zero.
Create uuid value with all bits set to one.
Generate uuid value (version 1).
Set the bits for version 3 and IETF variant, return uuid value.
Set the bits for version 3 and IETF variant, return uuid value.
Generate random uuid value (version 4).
Set the bits for version 4 and IETF variant, return uuid value.
Set the bits for version 5 and IETF variant, return uuid value.
Set the bits for version 5 and IETF variant, return uuid value.
Generate uuid value (version 6).
Implementation is based on generating a version 1 uuid value and reordering the timestamp. See frugal-uuid-v1.lisp for details.
Generate uuid value (version 7).
Generate a non-negative random number below LIMIT.
When no alternative source of randomness is provided via INITIALIZE-RANDOM, then sets up its own random number generator via *RANDOM-NUMBER-GENERATOR-INIT-FUNCTION* when first invoked.
Generate random node ID with multicast bit set.
Convert uuid value to integer representation.
Create a vector of octets from uuid value.
Convert uuid value into canonical textual representation.
Create a symbol (uppercase) from uuid value.
Loosely compares inputs representing UUIDs.
In addition to values of type uuid, it accepts symbols or strings with the canonical textual representation, integers and vectors of octets.
Strictly compare uuid inputs for equality.
Only accepts inputs of type uuid.
Represent UUID values as defined in RFC 4122
Low 32 bits of the time
(unsigned-byte 32)
:time-low
Middle 16 bits of the time
(unsigned-byte 16)
:time-mid
4-bit version followed by the high 12 bits of the time
(unsigned-byte 16)
:time-hi-and-version
1 to 3-bit variant followed by the 5 to 7 high bits of the clock sequence
(unsigned-byte 8)
:clock-seq-hi-and-res
Low 8 bits of the clock sequence
(unsigned-byte 8)
:clock-seq-low
v1-generator)) ¶automatically generated reader method
v1-generator)) ¶automatically generated writer method
v1-generator)) ¶automatically generated reader method
v1-generator)) ¶automatically generated writer method
v1-generator)) ¶automatically generated reader method
v1-generator)) ¶automatically generated writer method
v7-generator)) ¶automatically generated reader method
v7-generator)) ¶automatically generated writer method
v7-generator)) ¶automatically generated reader method
v7-generator)) ¶automatically generated writer method
| Jump to: | (
~
C F G I M N O P R T U V W |
|---|
| Jump to: | (
~
C F G I M N O P R T U V W |
|---|
| Jump to: | *
+
C N S T |
|---|
| Jump to: | *
+
C N S T |
|---|
| Jump to: | C F P S U V |
|---|
| Jump to: | C F P S U V |
|---|