The uuid Reference Manual

2.1.1 uuid/uuid.asd

Source

uuid.asd.

Parent Component

uuid (system).

ASDF Systems

uuid.

Packages

uuid-asd.

---

2.1.2 uuid/uuid.lisp

Source

uuid.asd.

Parent Component

uuid (system).

Packages

uuid.

Public Interface

• *ticks-per-count* (special variable).
• +namespace-dns+ (special variable).
• +namespace-oid+ (special variable).
• +namespace-url+ (special variable).
• +namespace-x500+ (special variable).
• byte-array-to-uuid (function).
• format-as-urn (function).
• make-null-uuid (function).
• make-uuid-from-string (function).
• make-v1-uuid (function).
• make-v3-uuid (function).
• make-v4-uuid (function).
• make-v5-uuid (function).
• print-bytes (function).
• print-object (method).
• uuid (class).
• uuid-to-byte-array (function).
• uuid= (function).

Internals

• *clock-seq* (special variable).
• *node* (special variable).
• *uuid-random-state* (special variable).
• arr-to-bytes (macro).
• clock-seq-low (reader method).
• (setf clock-seq-low) (writer method).
• clock-seq-var (reader method).
• (setf clock-seq-var) (writer method).
• digest-uuid (function).
• format-v3or5-uuid (function).
• get-node-id (function).
• get-timestamp (function).
• node (reader method).
• (setf node) (writer method).
• time-high (reader method).
• (setf time-high) (writer method).
• time-low (reader method).
• (setf time-low) (writer method).
• time-mid (reader method).
• (setf time-mid) (writer method).

---

4.1.1 Special variables

Special Variable: *ticks-per-count* ¶

Holds the amount of ticks per count. The ticks per count determine the number of possible version 1 uuids created for one time interval. Common Lisp provides INTERNAL-TIME-UNITS-PER-SECOND which gives the ticks per count for the current system so *ticks-per-count* can be set to INTERNAL-TIME-UNITS-PER-SECOND

Package

uuid.

Source

uuid.lisp.

Special Variable: +namespace-dns+ ¶

The DNS Namespace. Can be used for the generation of uuids version 3 and 5

Package

uuid.

Source

uuid.lisp.

Special Variable: +namespace-oid+ ¶

The OID Namespace. Can be used for the generation of uuids version 3 and 5

Package

uuid.

Source

uuid.lisp.

Special Variable: +namespace-url+ ¶

The URL Namespace. Can be used for the generation of uuids version 3 and 5

Package

uuid.

Source

uuid.lisp.

Special Variable: +namespace-x500+ ¶

The x500+ Namespace. Can be used for the generation of uuids version 3 and 5

Package

uuid.

Source

uuid.lisp.

---

4.1.2 Ordinary functions

Function: byte-array-to-uuid (array) ¶

Converts a byte-array generated with uuid-to-byte-array to an uuid.

Package

uuid.

Source

uuid.lisp.

Function: format-as-urn (stream uuid) ¶

Prints the uuid as a urn

Package

uuid.

Source

uuid.lisp.

Function: make-null-uuid () ¶

Generates a NULL uuid (i.e 00000000-0000-0000-0000-000000000000)

Package

uuid.

Source

uuid.lisp.

Function: make-uuid-from-string (string) ¶

Creates an uuid from the string represenation of an uuid. (example input string 6ba7b810-9dad-11d1-80b4-00c04fd430c8)

Package

uuid.

Source

uuid.lisp.

Function: make-v1-uuid () ¶

Generates a version 1 (time-based) uuid.

Package

uuid.

Source

uuid.lisp.

Function: make-v3-uuid (namespace name) ¶

Generates a version 3 (named based MD5) uuid.

Package

uuid.

Source

uuid.lisp.

Function: make-v4-uuid () ¶

Generates a version 4 (random) uuid

Package

uuid.

Source

uuid.lisp.

Function: make-v5-uuid (namespace name) ¶

Generates a version 5 (name based SHA1) uuid.

Package

uuid.

Source

uuid.lisp.

Function: print-bytes (stream uuid) ¶

Prints the raw bytes in hex form. (example output 6ba7b8109dad11d180b400c04fd430c8)

Package

uuid.

Source

uuid.lisp.

Function: uuid-to-byte-array (uuid) ¶

Converts an uuid to byte-array

Package

uuid.

Source

uuid.lisp.

Function: uuid= (uuid1 uuid2) ¶

Package

uuid.

Source

uuid.lisp.

---

4.1.3 Standalone methods

Method: print-object ((id uuid) stream) ¶

Prints an uuid in the string represenation of an uuid. (example string 6ba7b810-9dad-11d1-80b4-00c04fd430c8)

Source

uuid.lisp.

---

4.1.4 Classes

Class: uuid ¶

Represents an uuid

Package

uuid.

Source

uuid.lisp.

Direct methods

• (setf clock-seq-low).
• clock-seq-low.
• (setf clock-seq-var).
• clock-seq-var.
• (setf node).
• node.
• print-object.
• (setf time-high).
• time-high.
• (setf time-low).
• time-low.
• (setf time-mid).
• time-mid.

Direct slots

Slot: time-low ¶

Type

(unsigned-byte 32)

Initform

0

Initargs

:time-low

Readers

time-low.

Writers

(setf time-low).

Slot: time-mid ¶

Type

(unsigned-byte 16)

Initform

0

Initargs

:time-mid

Readers

time-mid.

Writers

(setf time-mid).

Slot: time-high-and-version ¶

Type

(unsigned-byte 16)

Initform

0

Initargs

:time-high

Readers

time-high.

Writers

(setf time-high).

Slot: clock-seq-and-reserved ¶

Type

(unsigned-byte 8)

Initform

0

Initargs

:clock-seq-var

Readers

clock-seq-var.

Writers

(setf clock-seq-var).

Slot: clock-seq-low ¶

Type

(unsigned-byte 8)

Initform

0

Initargs

:clock-seq-low

Readers

clock-seq-low.

Writers

(setf clock-seq-low).

Slot: node ¶

Type

(unsigned-byte 48)

Initform

0

Initargs

:node

Readers

node.

Writers

(setf node).

---

4.2.1 Special variables

Special Variable: *clock-seq* ¶

Holds the clock sequence. It is set when a version 1 uuid is generated for the first time and remains unchanged during a whole session.

Package

uuid.

Source

uuid.lisp.

Special Variable: *node* ¶

Holds the IEEE 802 MAC address or a random number when such is not available

Package

uuid.

Source

uuid.lisp.

Special Variable: *uuid-random-state* ¶

Holds the random state used for generation of random numbers

Package

uuid.

Source

uuid.lisp.

---

4.2.2 Macros

Macro: arr-to-bytes (from to array) ¶

Helper macro used in byte-array-to-uuid.

Package

uuid.

Source

uuid.lisp.

---

4.2.3 Ordinary functions

Function: digest-uuid (digest uuid name) ¶

Helper function that produces a digest from a namespace (a byte array) and a string. Used for the generation of version 3 and 5 uuids.

Package

uuid.

Source

uuid.lisp.

Function: format-v3or5-uuid (hash ver) ¶

Helper function to format a version 3 or 5 uuid. Formatting means setting the appropriate version bytes.

Package

uuid.

Source

uuid.lisp.

Function: get-node-id () ¶

Get MAC address of first ethernet device

Package

uuid.

Source

uuid.lisp.

Function: get-timestamp () ¶

Get timestamp, compensate nanoseconds intervals

Package

uuid.

Source

uuid.lisp.

---

4.2.4 Generic functions

Generic Reader: clock-seq-low (object) ¶

Package

uuid.

Methods

Reader Method: clock-seq-low ((uuid uuid)) ¶

automatically generated reader method

Source

uuid.lisp.

Target Slot

clock-seq-low.

Generic Writer: (setf clock-seq-low) (object) ¶

Package

uuid.

Methods

Writer Method: (setf clock-seq-low) ((uuid uuid)) ¶

automatically generated writer method

Source

uuid.lisp.

Target Slot

clock-seq-low.

Generic Reader: clock-seq-var (object) ¶

Package

uuid.

Methods

Reader Method: clock-seq-var ((uuid uuid)) ¶

automatically generated reader method

Source

uuid.lisp.

Target Slot

clock-seq-and-reserved.

Generic Writer: (setf clock-seq-var) (object) ¶

Package

uuid.

Methods

Writer Method: (setf clock-seq-var) ((uuid uuid)) ¶

automatically generated writer method

Source

uuid.lisp.

Target Slot

clock-seq-and-reserved.

Generic Reader: node (object) ¶

Package

uuid.

Methods

Reader Method: node ((uuid uuid)) ¶

automatically generated reader method

Source

uuid.lisp.

Target Slot

node.

Generic Writer: (setf node) (object) ¶

Package

uuid.

Methods

Writer Method: (setf node) ((uuid uuid)) ¶

automatically generated writer method

Source

uuid.lisp.

Target Slot

node.

Generic Reader: time-high (object) ¶

Package

uuid.

Methods

Reader Method: time-high ((uuid uuid)) ¶

automatically generated reader method

Source

uuid.lisp.

Target Slot

time-high-and-version.

Generic Writer: (setf time-high) (object) ¶

Package

uuid.

Methods

Writer Method: (setf time-high) ((uuid uuid)) ¶

automatically generated writer method

Source

uuid.lisp.

Target Slot

time-high-and-version.

Generic Reader: time-low (object) ¶

Package

uuid.

Methods

Reader Method: time-low ((uuid uuid)) ¶

automatically generated reader method

Source

uuid.lisp.

Target Slot

time-low.

Generic Writer: (setf time-low) (object) ¶

Package

uuid.

Methods

Writer Method: (setf time-low) ((uuid uuid)) ¶

automatically generated writer method

Source

uuid.lisp.

Target Slot

time-low.

Generic Reader: time-mid (object) ¶

Package

uuid.

Methods

Reader Method: time-mid ((uuid uuid)) ¶

automatically generated reader method

Source

uuid.lisp.

Target Slot

time-mid.

Generic Writer: (setf time-mid) (object) ¶

Package

uuid.

Methods

Writer Method: (setf time-mid) ((uuid uuid)) ¶

automatically generated writer method

Source

uuid.lisp.

Target Slot

time-mid.

---