The uuid Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The uuid Reference Manual

This is the uuid Reference Manual, version 2012.12.26, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:43:28 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

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


Previous: , Up: Systems   [Contents][Index]

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
Source

uuid.asd (file)

Component

uuid.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

2 Files

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


Previous: , Up: Files   [Contents][Index]

2.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.1 uuid.asd

Location

uuid.asd

Systems

uuid (system)

Packages

uuid-asd


Previous: , Up: Lisp files   [Contents][Index]

2.1.2 uuid/uuid.lisp

Parent

uuid (system)

Location

uuid.lisp

Packages

uuid

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

3 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

3.1 uuid-asd

Source

uuid.asd

Use List

Previous: , Up: Packages   [Contents][Index]

3.2 uuid

Source

uuid.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

4.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Exported definitions   [Contents][Index]

4.1.3 Classes

Class: uuid ()

Represents an uuid

Package

uuid

Source

uuid.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
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)


Previous: , Up: Definitions   [Contents][Index]

4.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   U  
Index Entry  Section

F
File, Lisp, uuid.asd: The uuid<dot>asd file
File, Lisp, uuid/uuid.lisp: The uuid/uuid<dot>lisp file

L
Lisp File, uuid.asd: The uuid<dot>asd file
Lisp File, uuid/uuid.lisp: The uuid/uuid<dot>lisp file

U
uuid.asd: The uuid<dot>asd file
uuid/uuid.lisp: The uuid/uuid<dot>lisp file

Jump to:   F   L   U  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
A   B   C   D   F   G   M   N   P   T   U  
Index Entry  Section

(
(setf clock-seq-low): Internal generic functions
(setf clock-seq-low): Internal generic functions
(setf clock-seq-var): Internal generic functions
(setf clock-seq-var): Internal generic functions
(setf node): Internal generic functions
(setf node): Internal generic functions
(setf time-high): Internal generic functions
(setf time-high): Internal generic functions
(setf time-low): Internal generic functions
(setf time-low): Internal generic functions
(setf time-mid): Internal generic functions
(setf time-mid): Internal generic functions

A
arr-to-bytes: Internal macros

B
byte-array-to-uuid: Exported functions

C
clock-seq-low: Internal generic functions
clock-seq-low: Internal generic functions
clock-seq-var: Internal generic functions
clock-seq-var: Internal generic functions

D
digest-uuid: Internal functions

F
format-as-urn: Exported functions
format-v3or5-uuid: Internal functions
Function, byte-array-to-uuid: Exported functions
Function, digest-uuid: Internal functions
Function, format-as-urn: Exported functions
Function, format-v3or5-uuid: Internal functions
Function, get-node-id: Internal functions
Function, get-timestamp: Internal functions
Function, make-null-uuid: Exported functions
Function, make-uuid-from-string: Exported functions
Function, make-v1-uuid: Exported functions
Function, make-v3-uuid: Exported functions
Function, make-v4-uuid: Exported functions
Function, make-v5-uuid: Exported functions
Function, print-bytes: Exported functions
Function, uuid-to-byte-array: Exported functions
Function, uuid=: Exported functions

G
Generic Function, (setf clock-seq-low): Internal generic functions
Generic Function, (setf clock-seq-var): Internal generic functions
Generic Function, (setf node): Internal generic functions
Generic Function, (setf time-high): Internal generic functions
Generic Function, (setf time-low): Internal generic functions
Generic Function, (setf time-mid): Internal generic functions
Generic Function, clock-seq-low: Internal generic functions
Generic Function, clock-seq-var: Internal generic functions
Generic Function, node: Internal generic functions
Generic Function, time-high: Internal generic functions
Generic Function, time-low: Internal generic functions
Generic Function, time-mid: Internal generic functions
get-node-id: Internal functions
get-timestamp: Internal functions

M
Macro, arr-to-bytes: Internal macros
make-null-uuid: Exported functions
make-uuid-from-string: Exported functions
make-v1-uuid: Exported functions
make-v3-uuid: Exported functions
make-v4-uuid: Exported functions
make-v5-uuid: Exported functions
Method, (setf clock-seq-low): Internal generic functions
Method, (setf clock-seq-var): Internal generic functions
Method, (setf node): Internal generic functions
Method, (setf time-high): Internal generic functions
Method, (setf time-low): Internal generic functions
Method, (setf time-mid): Internal generic functions
Method, clock-seq-low: Internal generic functions
Method, clock-seq-var: Internal generic functions
Method, node: Internal generic functions
Method, time-high: Internal generic functions
Method, time-low: Internal generic functions
Method, time-mid: Internal generic functions

N
node: Internal generic functions
node: Internal generic functions

P
print-bytes: Exported functions

T
time-high: Internal generic functions
time-high: Internal generic functions
time-low: Internal generic functions
time-low: Internal generic functions
time-mid: Internal generic functions
time-mid: Internal generic functions

U
uuid-to-byte-array: Exported functions
uuid=: Exported functions

Jump to:   (  
A   B   C   D   F   G   M   N   P   T   U  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   +  
C   N   S   T  
Index Entry  Section

*
*clock-seq*: Internal special variables
*node*: Internal special variables
*ticks-per-count*: Exported special variables
*uuid-random-state*: Internal special variables

+
+namespace-dns+: Exported special variables
+namespace-oid+: Exported special variables
+namespace-url+: Exported special variables
+namespace-x500+: Exported special variables

C
clock-seq-and-reserved: Exported classes
clock-seq-low: Exported classes

N
node: Exported classes

S
Slot, clock-seq-and-reserved: Exported classes
Slot, clock-seq-low: Exported classes
Slot, node: Exported classes
Slot, time-high-and-version: Exported classes
Slot, time-low: Exported classes
Slot, time-mid: Exported classes
Special Variable, *clock-seq*: Internal special variables
Special Variable, *node*: Internal special variables
Special Variable, *ticks-per-count*: Exported special variables
Special Variable, *uuid-random-state*: Internal special variables
Special Variable, +namespace-dns+: Exported special variables
Special Variable, +namespace-oid+: Exported special variables
Special Variable, +namespace-url+: Exported special variables
Special Variable, +namespace-x500+: Exported special variables

T
time-high-and-version: Exported classes
time-low: Exported classes
time-mid: Exported classes

Jump to:   *   +  
C   N   S   T  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S   U  
Index Entry  Section

C
Class, uuid: Exported classes

P
Package, uuid: The uuid package
Package, uuid-asd: The uuid-asd package

S
System, uuid: The uuid system

U
uuid: The uuid system
uuid: The uuid package
uuid: Exported classes
uuid-asd: The uuid-asd package

Jump to:   C   P   S   U