The random-uuid Reference Manual

This is the random-uuid Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:43:25 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 random-uuid

Create and parse RFC-4122 UUID version 4 identifiers.

Author

Michael Fiano <>

Home Page

https://git.mfiano.net/mfiano/random-uuid

License

MIT

Dependencies
  • mfiano-utils (system).
  • seedable-rng (system).
Source

random-uuid.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 random-uuid/random-uuid.asd

Source

random-uuid.asd.

Parent Component

random-uuid (system).

ASDF Systems

random-uuid.


3.1.2 random-uuid/package.lisp

Source

random-uuid.asd.

Parent Component

random-uuid (system).

Packages

random-uuid.


3.1.3 random-uuid/conditions.lisp

Dependency

package.lisp (file).

Source

random-uuid.asd.

Parent Component

random-uuid (system).

Internals

3.1.4 random-uuid/uuid.lisp

Dependency

conditions.lisp (file).

Source

random-uuid.asd.

Parent Component

random-uuid (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 random-uuid

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: from-string (string)

Construct a UUID object by parsing the string representation of a UUID.

Package

random-uuid.

Source

uuid.lisp.

Function: make-uuid (&optional generator)

Construct a new RFC-4122 v4 UUID. ‘generator‘ if supplied is a generator object created with the seedable-rng library. This allows generating a deterministic sequence of random UUID’s.

Package

random-uuid.

Source

uuid.lisp.

Function: to-string (uuid)

Convert a UUID to its string representation.

Package

random-uuid.

Source

uuid.lisp.

Function: valid-string-p (string)

Check whether the given string is a valid representation of a UUID.

Package

random-uuid.

Source

uuid.lisp.

Reader: variant (instance)
Writer: (setf variant) (instance)
Package

random-uuid.

Source

uuid.lisp.

Target Slot

variant.

Reader: version (instance)
Writer: (setf version) (instance)
Package

random-uuid.

Source

uuid.lisp.

Target Slot

version.


5.1.2 Standalone methods

Method: print-object ((uuid uuid) stream)
Source

uuid.lisp.


5.1.3 Structures

Structure: uuid
Package

random-uuid.

Source

uuid.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots
Slot: version
Type

fixnum

Initform

4

Readers

version.

Writers

(setf version).

Slot: variant
Initform

:rfc-4122

Readers

variant.

Writers

(setf variant).

Slot: low
Type

mfiano-utils:ub64

Initform

0

Readers

low.

Writers

(setf low).

Slot: high
Type

mfiano-utils:ub64

Initform

0

Readers

high.

Writers

(setf high).


5.2 Internals


5.2.1 Ordinary functions

Function: %make-uuid (&key version variant low high)
Package

random-uuid.

Source

uuid.lisp.

Reader: high (instance)
Writer: (setf high) (instance)
Package

random-uuid.

Source

uuid.lisp.

Target Slot

high.

Reader: low (instance)
Writer: (setf low) (instance)
Package

random-uuid.

Source

uuid.lisp.

Target Slot

low.


5.2.2 Generic functions

Generic Reader: uuid-string (condition)
Package

random-uuid.

Methods
Reader Method: uuid-string ((condition invalid-string))
Source

conditions.lisp.

Target Slot

%uuid-string.


5.2.3 Conditions

Condition: invalid-string
Package

random-uuid.

Source

conditions.lisp.

Direct superclasses

condition.

Direct methods

uuid-string.

Direct slots
Slot: %uuid-string
Initargs

:string

Readers

uuid-string.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
F   G   H   L   M   P   T   U   V  
Index Entry  Section

%
%make-uuid: Private ordinary functions

(
(setf high): Private ordinary functions
(setf low): Private ordinary functions
(setf variant): Public ordinary functions
(setf version): Public ordinary functions

F
from-string: Public ordinary functions
Function, %make-uuid: Private ordinary functions
Function, (setf high): Private ordinary functions
Function, (setf low): Private ordinary functions
Function, (setf variant): Public ordinary functions
Function, (setf version): Public ordinary functions
Function, from-string: Public ordinary functions
Function, high: Private ordinary functions
Function, low: Private ordinary functions
Function, make-uuid: Public ordinary functions
Function, to-string: Public ordinary functions
Function, valid-string-p: Public ordinary functions
Function, variant: Public ordinary functions
Function, version: Public ordinary functions

G
Generic Function, uuid-string: Private generic functions

H
high: Private ordinary functions

L
low: Private ordinary functions

M
make-uuid: Public ordinary functions
Method, print-object: Public standalone methods
Method, uuid-string: Private generic functions

P
print-object: Public standalone methods

T
to-string: Public ordinary functions

U
uuid-string: Private generic functions
uuid-string: Private generic functions

V
valid-string-p: Public ordinary functions
variant: Public ordinary functions
version: Public ordinary functions