The random-uuid Reference Manual

Table of Contents

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

The random-uuid Reference Manual

This is the random-uuid Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 17:36:20 2021 GMT+0.


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

1 Introduction

random-uuid

Provides an efficient implementation of RFC-4122 UUID version 4.

Overview

This library provides the ability to generate random UUID's, and parse UUID strings into UUID objects.

Install

(ql:quickload :random-uuid)

Usage

(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.

(from-string string)

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

(to-string uuid)

Convert a UUID to its string representation.

(valid-string-p string)

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

License

Copyright © Michael Fiano mail@mfiano.net.

Licensed under the MIT License.


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

2 Systems

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


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

2.1 random-uuid

Author

Michael Fiano <mail@mfiano.net>

Home Page

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

License

MIT

Description

Create and parse RFC-4122 UUID version 4 identifiers.

Dependencies
Source

random-uuid.asd (file)

Components

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

3 Files

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


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

3.1 Lisp


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

3.1.1 random-uuid.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/random-uuid-20210411-git/random-uuid.asd

Systems

random-uuid (system)


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

3.1.2 random-uuid/package.lisp

Parent

random-uuid (system)

Location

package.lisp

Packages

random-uuid


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

3.1.3 random-uuid/conditions.lisp

Dependency

package.lisp (file)

Parent

random-uuid (system)

Location

conditions.lisp

Internal Definitions

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

3.1.4 random-uuid/uuid.lisp

Dependency

conditions.lisp (file)

Parent

random-uuid (system)

Location

uuid.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 random-uuid

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Functions

Function: from-string STRING

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

Package

random-uuid

Source

uuid.lisp (file)

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

Function: to-string UUID

Convert a UUID to its string representation.

Package

random-uuid

Source

uuid.lisp (file)

Function: valid-string-p STRING

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

Package

random-uuid

Source

uuid.lisp (file)

Function: variant INSTANCE
Function: (setf variant) VALUE INSTANCE
Package

random-uuid

Source

uuid.lisp (file)

Function: version INSTANCE
Function: (setf version) VALUE INSTANCE
Package

random-uuid

Source

uuid.lisp (file)


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

5.1.2 Structures

Structure: uuid ()
Package

random-uuid

Source

uuid.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

print-object (method)

Direct slots
Slot: version
Type

fixnum

Initform

4

Readers

version (function)

Writers

(setf version) (function)

Slot: variant
Initform

:rfc-4122

Readers

variant (function)

Writers

(setf variant) (function)

Slot: low
Type

golden-utils:ub64

Initform

0

Readers

low (function)

Writers

(setf low) (function)

Slot: high
Type

golden-utils:ub64

Initform

0

Readers

high (function)

Writers

(setf high) (function)


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

5.2 Internal definitions


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

5.2.1 Functions

Function: %make-uuid &key (VERSION VERSION) (VARIANT VARIANT) (LOW LOW) (HIGH HIGH)
Package

random-uuid

Source

uuid.lisp (file)

Function: high INSTANCE
Function: (setf high) VALUE INSTANCE
Package

random-uuid

Source

uuid.lisp (file)

Function: low INSTANCE
Function: (setf low) VALUE INSTANCE
Package

random-uuid

Source

uuid.lisp (file)


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

5.2.2 Generic functions

Generic Function: uuid-string CONDITION
Package

random-uuid

Methods
Method: uuid-string (CONDITION invalid-string)
Source

conditions.lisp (file)


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

5.2.3 Conditions

Condition: invalid-string ()
Package

random-uuid

Source

conditions.lisp (file)

Direct superclasses

condition (condition)

Direct methods

uuid-string (method)

Direct slots
Slot: %uuid-string
Initargs

:string

Readers

uuid-string (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   R  
Index Entry  Section

F
File, Lisp, random-uuid.asd: The random-uuid․asd file
File, Lisp, random-uuid/conditions.lisp: The random-uuid/conditions․lisp file
File, Lisp, random-uuid/package.lisp: The random-uuid/package․lisp file
File, Lisp, random-uuid/uuid.lisp: The random-uuid/uuid․lisp file

L
Lisp File, random-uuid.asd: The random-uuid․asd file
Lisp File, random-uuid/conditions.lisp: The random-uuid/conditions․lisp file
Lisp File, random-uuid/package.lisp: The random-uuid/package․lisp file
Lisp File, random-uuid/uuid.lisp: The random-uuid/uuid․lisp file

R
random-uuid.asd: The random-uuid․asd file
random-uuid/conditions.lisp: The random-uuid/conditions․lisp file
random-uuid/package.lisp: The random-uuid/package․lisp file
random-uuid/uuid.lisp: The random-uuid/uuid․lisp file

Jump to:   F   L   R  

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

A.2 Functions

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

%
%make-uuid: Internal functions

(
(setf high): Internal functions
(setf low): Internal functions
(setf variant): Exported functions
(setf version): Exported functions

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

G
Generic Function, uuid-string: Internal generic functions

H
high: Internal functions

L
low: Internal functions

M
make-uuid: Exported functions
Method, uuid-string: Internal generic functions

T
to-string: Exported functions

U
uuid-string: Internal generic functions
uuid-string: Internal generic functions

V
valid-string-p: Exported functions
variant: Exported functions
version: Exported functions

Jump to:   %   (  
F   G   H   L   M   T   U   V  

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

A.3 Variables

Jump to:   %  
H   L   S   V  
Index Entry  Section

%
%uuid-string: Internal conditions

H
high: Exported structures

L
low: Exported structures

S
Slot, %uuid-string: Internal conditions
Slot, high: Exported structures
Slot, low: Exported structures
Slot, variant: Exported structures
Slot, version: Exported structures

V
variant: Exported structures
version: Exported structures

Jump to:   %  
H   L   S   V  

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

A.4 Data types

Jump to:   C   I   P   R   S   U  
Index Entry  Section

C
Condition, invalid-string: Internal conditions

I
invalid-string: Internal conditions

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

R
random-uuid: The random-uuid system
random-uuid: The random-uuid package

S
Structure, uuid: Exported structures
System, random-uuid: The random-uuid system

U
uuid: Exported structures

Jump to:   C   I   P   R   S   U