The uuid Reference Manual

Table of Contents

The uuid Reference Manual

This is the uuid Reference Manual, version 2012.12.26, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 15:26:01 2020 GMT+0.

1 Systems

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

1.1 uuid

Maintainer

Boian Tzonev

Author

Boian Tzonev

License

LLGPL

Description

UUID Generation

Long Description

Lisp implementation of rfc 4122

Version

2012.12.26

Dependencies

• ironclad
• trivial-utf-8

Source

uuid.asd (file)

Component

uuid.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 uuid.asd

Location

uuid.asd

Systems

uuid (system)

Packages

uuid-asd

2.1.2 uuid/uuid.lisp

Parent

uuid (system)

Location

uuid.lisp

Packages

uuid

Exported Definitions

• *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)
• uuid (class)
• uuid-to-byte-array (function)
• uuid= (function)

Internal Definitions

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

3 Packages

Packages are listed by definition order.

3.1 uuid-asd

Source

uuid.asd

Use List

• asdf/interface
• common-lisp

3.2 uuid

Source

uuid.lisp (file)

Use List

common-lisp

Exported Definitions

• *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)
• uuid (class)
• uuid-to-byte-array (function)
• uuid= (function)

Internal Definitions

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

4 Definitions

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

4.1 Exported definitions

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 (file)

Special Variable: +namespace-dns+

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

Package

uuid

Source

uuid.lisp (file)

Special Variable: +namespace-oid+

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

Package

uuid

Source

uuid.lisp (file)

Special Variable: +namespace-url+

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

Package

uuid

Source

uuid.lisp (file)

Special Variable: +namespace-x500+

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

Package

uuid

Source

uuid.lisp (file)

4.1.2 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 (file)

Function: format-as-urn STREAM UUID

Prints the uuid as a urn

Package

uuid

Source

uuid.lisp (file)

Function: make-null-uuid ()

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

Package

uuid

Source

uuid.lisp (file)

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 (file)

Function: make-v1-uuid ()

Generates a version 1 (time-based) uuid.

Package

uuid

Source

uuid.lisp (file)

Function: make-v3-uuid NAMESPACE NAME

Generates a version 3 (named based MD5) uuid.

Package

uuid

Source

uuid.lisp (file)

Function: make-v4-uuid ()

Generates a version 4 (random) uuid

Package

uuid

Source

uuid.lisp (file)

Function: make-v5-uuid NAMESPACE NAME

Generates a version 5 (name based SHA1) uuid.

Package

uuid

Source

uuid.lisp (file)

Function: print-bytes STREAM UUID

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

Package

uuid

Source

uuid.lisp (file)

Function: uuid-to-byte-array UUID

Converts an uuid to byte-array

Package

uuid

Source

uuid.lisp (file)

Function: uuid= UUID1 UUID2

Package

uuid

Source

uuid.lisp (file)

4.1.3 Classes

Class: uuid ()

Represents an uuid

Package

uuid

Source

uuid.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

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

Direct slots

Slot: time-low

Type

(unsigned-byte 32)

Initargs

:time-low

Initform

0

Readers

time-low (generic function)

Writers

(setf time-low) (generic function)

Slot: time-mid

Type

(unsigned-byte 16)

Initargs

:time-mid

Initform

0

Readers

time-mid (generic function)

Writers

(setf time-mid) (generic function)

Slot: time-high-and-version

Type

(unsigned-byte 16)

Initargs

:time-high

Initform

0

Readers

time-high (generic function)

Writers

(setf time-high) (generic function)

Slot: clock-seq-and-reserved

Type

(unsigned-byte 8)

Initargs

:clock-seq-var

Initform

0

Readers

clock-seq-var (generic function)

Writers

(setf clock-seq-var) (generic function)

Slot: clock-seq-low

Type

(unsigned-byte 8)

Initargs

:clock-seq-low

Initform

0

Readers

clock-seq-low (generic function)

Writers

(setf clock-seq-low) (generic function)

Slot: node

Type

(unsigned-byte 48)

Initargs

:node

Initform

0

Readers

node (generic function)

Writers

(setf node) (generic function)

4.2 Internal definitions

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 (file)

Special Variable: *node*

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

Package

uuid

Source

uuid.lisp (file)

Special Variable: *uuid-random-state*

Holds the random state used for generation of random numbers

Package

uuid

Source

uuid.lisp (file)

4.2.2 Macros

Macro: arr-to-bytes FROM TO ARRAY

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

Package

uuid

Source

uuid.lisp (file)

4.2.3 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 (file)

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 (file)

Function: get-node-id ()

Get MAC address of first ethernet device

Package

uuid

Source

uuid.lisp (file)

Function: get-timestamp ()

Get timestamp, compensate nanoseconds intervals

Package

uuid

Source

uuid.lisp (file)

4.2.4 Generic functions

Generic Function: clock-seq-low OBJECT

Generic Function: (setf clock-seq-low) NEW-VALUE OBJECT

Package

uuid

Methods

Method: clock-seq-low (UUID uuid)

automatically generated reader method

Source

uuid.lisp (file)

Method: (setf clock-seq-low) NEW-VALUE (UUID uuid)

automatically generated writer method

Source

uuid.lisp (file)

Generic Function: clock-seq-var OBJECT

Generic Function: (setf clock-seq-var) NEW-VALUE OBJECT

Package

uuid

Methods

Method: clock-seq-var (UUID uuid)

automatically generated reader method

Source

uuid.lisp (file)

Method: (setf clock-seq-var) NEW-VALUE (UUID uuid)

automatically generated writer method

Source

uuid.lisp (file)

Generic Function: node OBJECT

Generic Function: (setf node) NEW-VALUE OBJECT

Package

uuid

Methods

Method: node (UUID uuid)

automatically generated reader method

Source

uuid.lisp (file)

Method: (setf node) NEW-VALUE (UUID uuid)

automatically generated writer method

Source

uuid.lisp (file)

Generic Function: time-high OBJECT

Generic Function: (setf time-high) NEW-VALUE OBJECT

Package

uuid

Methods

Method: time-high (UUID uuid)

automatically generated reader method

Source

uuid.lisp (file)

Method: (setf time-high) NEW-VALUE (UUID uuid)

automatically generated writer method

Source

uuid.lisp (file)

Generic Function: time-low OBJECT

Generic Function: (setf time-low) NEW-VALUE OBJECT

Package

uuid

Methods

Method: time-low (UUID uuid)

automatically generated reader method

Source

uuid.lisp (file)

Method: (setf time-low) NEW-VALUE (UUID uuid)

automatically generated writer method

Source

uuid.lisp (file)

Generic Function: time-mid OBJECT

Generic Function: (setf time-mid) NEW-VALUE OBJECT

Package

uuid

Methods

Method: time-mid (UUID uuid)

automatically generated reader method

Source

uuid.lisp (file)

Method: (setf time-mid) NEW-VALUE (UUID uuid)

automatically generated writer method

Source

uuid.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types